Skip to content

Commit 9e88d62

Browse files
committed
Conductor: further explain setup steps
1 parent 87b0bc4 commit 9e88d62

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

docs/conductor/getting-started.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,32 @@
11
# Getting started with Conductor
22
##
33

4-
Conductor will group and schedule automated dependency updates on your own Continuous Integration platform. If the update succeeds, Conductor sends you a pull request to your code hosting platform (GitHub, GitLab, Bitbucket) with the changed composer.lock file and, if necessary, other files modified by Composer plugins or scripts.
4+
Conductor will group and schedule automated dependency updates on your own Continuous Integration platform. If the update succeeds, Conductor will send you a pull request to your code hosting platform (GitHub, GitLab, Bitbucket) with the changed composer.lock file and, if necessary, other files modified by Composer plugins or scripts.
55

66
To use Conductor:
77

8-
- You need to be approved for early access to Conductor. [Join to the waitlist](/features/conductor) and wait for approval.
8+
- You need to be approved for early access to Conductor. [Join the waitlist](/features/conductor) and wait for approval.
99
- You need a Private Packagist trial or subscription on the cloud plan.
10-
- You need to add a workflow to your Continuous Integration platform to run Composer updates, described below.
10+
- You need to add a synchronization with your code hosting platform.
11+
- You need to add a workflow to your Continuous Integration platform to run Composer updates.
1112

12-
## Add packages to update automatically
13+
## Add a synchronization
1314

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.
15+
Once you have a Private Packagist organization and Conductor is enabled for you, log into your Private Packagist organization and head to the "Settings" tab in the main navigation.
16+
Under the "Synchronization" entry you can add [one or more synchronizations](/features/integration-github-bitbucket-gitlab.md) with an organization on your code hosting platform.
17+
This is how you grant us access to your repositories. Once done we will automatically add any repository with a composer.json file in the root directory as a package to Private Packagist.
1518

19+
## Configure Conductor for your packages
20+
21+
Access the "Conductor" tab in the main navigation to see a list of available packages that can be managed via Conductor.
22+
Each package shown is linked to a repository where you would like to receive pull requests from Conductor. This usually includes all your Composer projects.
1623
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.
1724

18-
## Create a workflow on your CI
25+
To get started, click on the configure link displayed for the package where you want to use Conductor and follow the instructions for your Continuous Integration platform.
1926

2027
### GitHub Actions
2128

22-
Create a new GitHub Actions workflow in `.github/workflows/dependency-update.yaml` of your GitHub repository using the template below:
29+
Create a new GitHub Actions workflow in `.github/workflows/conductor.yaml` of your GitHub repository using the template below:
2330

2431
CONDUCTOR_GITHUB_ACTIONS_WORKFLOW
2532

@@ -31,13 +38,13 @@ We recommend to create a dedicated authentication token with update access. You
3138

3239
![Create Authentication Token](/Resources/public/img/docs/conductor/authentication-token.png)
3340

34-
The contents of the variable should look like
41+
The contents of the variable should look like
3542

3643
```json
3744
{"http-basic": {"repo.packagist.com": {"username": "token", "password": "packagist_out_73a81c..." }}}
3845
```
3946

40-
Conductor needs to verify your CI setup before you can start receiving pull requests.
47+
Conductor needs to verify your CI setup before you can start receiving PRs.
4148

4249
## Verify your CI setup
4350

@@ -58,7 +65,7 @@ When you run into errors, troubleshoot and fix them. You can trigger the workflo
5865

5966
## How scheduling works
6067

61-
- Navigate to the "Updates" tab in your Private Packagist organization
68+
- Navigate to the "Conductor" tab in your Private Packagist organization
6269
- Click on the name of your package
6370

6471
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.
@@ -79,7 +86,7 @@ If all these steps succeeded, Private Packagist creates a pull request for the n
7986
![Conductor Pull Request](https://packagist.com/img/features/auto-updates/merged-PR-for-a-security-updated.png)
8087

8188
Once you reviewed the changes and merged the PR, Conductor will schedule the next task.
82-
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.
89+
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.
8390

8491
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".
8592

0 commit comments

Comments
 (0)