Skip to content

Commit c016f9e

Browse files
committed
all suggestions from code review
1 parent 6c9c6a2 commit c016f9e

File tree

1 file changed

+14
-19
lines changed

1 file changed

+14
-19
lines changed

docs/conductor/getting-started.md

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,33 +5,28 @@ Conductor will group and schedule automated Dependency Updates on your own Conti
55

66
To use Conductor:
77

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.
1010
- You need to add a workflow to your Continuous Integration platform to run Composer updates, described below.
1111

12-
## First steps
12+
## Add packages to update automatically
1313

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.
1915

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.
2117

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.
2319

2420
## Create a workflow on your CI
2521

2622
### GitHub Actions
2723

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:
2925

3026
CONDUCTOR_GITHUB_ACTIONS_WORKFLOW
3127

3228
1. Adjust the PHP Version used in the "Install PHP" step
3329
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
3530

3631
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.
3732
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
4439
{"http-basic": {"repo.packagist.com": {"username": "token", "password": "packagist_out_73a81c..." }}}
4540
```
4641

47-
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.
4843

4944
## How scheduling works
5045

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
5247
- Click on the name of your package
5348

5449
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
6964
![Conductor Pull Request](https://packagist.com/img/features/auto-updates/merged-PR-for-a-security-updated.png)
7065

7166
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.
7368

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".
7570

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.
7772

7873
## Verify your CI setup
7974

@@ -85,9 +80,9 @@ The verification task will only execute `composer update nothing` and will not r
8580
- Click on the task "Verify the continuous integration setup"
8681
- Use the "Schedule now" button to test your setup
8782

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:
8984
You should see a run for the just added workflow. Examine the run if it succeeded.
9085

9186
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.
9287

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

Comments
 (0)