You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/conductor/getting-started.md
+14-19Lines changed: 14 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -5,33 +5,28 @@ Conductor will group and schedule automated Dependency Updates on your own Conti
5
5
6
6
To use Conductor:
7
7
8
-
- You need to be approved for early access to conductor. [Join to the waitlist](http://packagist.com.lo/features/conductor) and wait for approval.
9
-
- You need a Private Packagist trial or subscription (Cloud or Self-Hosted).
8
+
- You need to be approved for early access to Conductor. [Join to the waitlist](/features/conductor) and wait for approval.
9
+
- You need a Private Packagist trial or subscription on the cloud plan.
10
10
- You need to add a workflow to your Continuous Integration platform to run Composer updates, described below.
11
11
12
-
## First steps
12
+
## Add packages to update automatically
13
13
14
-
Once you have a Private Packagist Subscription and Conductor is enabled for your subscription, log into your Private Packagist organization and click on the "Updates" tab in the main navigation.
15
-
Conductor will list packages:
16
-
- added to Private Packagist via synchronization
17
-
- having a composer.lock file commited to the repository
18
-
- having the Private Packagist repository added to the composer.json
14
+
Once you have a Private Packagist organization and Conductor is enabled for you, log into your Private Packagist organization and click on the "Updates" tab in the main navigation.
19
15
20
-
If you do not see your package, follow the instructions on your organization page to add the custom repository to the composer.json of your package.
16
+
Conductor will manage dependencies for packages added to Private Packagist [via synchronization](/features/integration-github-bitbucket-gitlab.md) that have a composer.lock file committed to the repository.
21
17
22
-
Most convenient way to set up Conductor is to configure your CI in the Private Packagist UI. The manual steps are outlined below:
18
+
If you do not see your package, follow the instructions on your organization page to add the custom repository to the composer.json of your package.
23
19
24
20
## Create a workflow on your CI
25
21
26
22
### GitHub Actions
27
23
28
-
Create a new GitHub Actions workflow in `.github/workflows/dependency-update.yaml` of your package repository using the template below:
24
+
Create a new GitHub Actions workflow in `.github/workflows/dependency-update.yaml` of your GitHub repository using the template below:
29
25
30
26
CONDUCTOR_GITHUB_ACTIONS_WORKFLOW
31
27
32
28
1. Adjust the PHP Version used in the "Install PHP" step
33
29
2. Commit and push the workflow to your main branch of your package repository
34
-
3. Review the steps to commit and push to your repository
35
30
36
31
Create a secret `COMPOSER_AUTH` with the Composer authentication configuration [as described here](https://getcomposer.org/doc/articles/authentication-for-private-packages.md#authentication-using-the-composer-auth-environment-variable) to access Private Packagist.
37
32
We recommend to create a dedicated authentication token with update access. You can copy and paste the contents for the secret from the Private Packagist UI while creating the token in "Settings" -> "Authentication Tokens". Remove the single quotes around the value.
@@ -44,11 +39,11 @@ The contents of the variable should look like
Conductor needs to verify your setup before you can [start receiving Pull Requests](#how-scheduling-works).
42
+
Conductor needs to [verify your CI setup](#verify-your-ci-setup) before you can start receiving pull requests.
48
43
49
44
## How scheduling works
50
45
51
-
-Go to your package on the updates tab in your Private Packagist organization
46
+
-Navigate to the "Updates" tab in your Private Packagist organization
52
47
- Click on the name of your package
53
48
54
49
The list shows groups of all available updates to be scheduled. Each group of updates is called a task. Conductor will schedule only one task at a time. All others are waiting for the task on top of the list to be successful or paused.
@@ -69,11 +64,11 @@ If all these steps succeeded, Private Packagist creates a pull request for the j
Once you reviewed the changes and merged the PR, Conductor will schedule the next task.
72
-
If you close the PR, the task will be paused and Conductor will schedule the next task. This is the same effect as using the "Pause" button in the UI. Conductor won't attempt to update the dependency to this exact version, but will schedule updates with newer versions.
67
+
If you close the PR, the task will be paused and Conductor will schedule the next task. This is the same effect as using the "Pause" button in the UI. Conductor won't attempt to update the dependency to this exact version again but will schedule updates with newer versions.
73
68
74
-
If you want to, schedule any other task of the list by clicking on its name and using the button "Schedule now to create a PR".
69
+
If you want to schedule any other task in the list, click on its name and use the button "Schedule now to create a PR".
75
70
76
-
Tasks fixing security issues have a higher priority. They will be moved to the top of the list and scheduled right away.
71
+
Tasks fixing security issues have a higher priority. They will be moved to the top of the list and scheduled right away even if there already is a PR for another task open.
77
72
78
73
## Verify your CI setup
79
74
@@ -85,9 +80,9 @@ The verification task will only execute `composer update nothing` and will not r
85
80
- Click on the task "Verify the continuous integration setup"
86
81
- Use the "Schedule now" button to test your setup
87
82
88
-
You can see the state of your task and last events for the task. Once the task is executed, watch your CI platform:
83
+
You can see the state of your task and the last events for the task. Once the task is executed, watch your CI platform:
89
84
You should see a run for the just added workflow. Examine the run if it succeeded.
90
85
91
86
If it was successful your CI configuration is verified and complete. Conductor will trigger your workflow with the next task in the list. This time it will send a pull request.
92
87
93
-
When you ran into errors, troubleshoot and fix. You can trigger the workflow again by restarting the CI verification task. The restart button is available after the first execution.
88
+
When you run into errors, troubleshoot and fix them. You can trigger the workflow again by restarting the CI verification task. The restart button is available after the first execution.
0 commit comments