Skip to content

Commit 2247f81

Browse files
committed
add other half of feedback
1 parent 7e9f90d commit 2247f81

File tree

1 file changed

+20
-21
lines changed

1 file changed

+20
-21
lines changed

docs/conductor/getting-started.md

+20-21
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ Once you have a Private Packagist organization and Conductor is enabled for you,
1515

1616
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.
1717

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.
19-
2018
## Create a workflow on your CI
2119

2220
### GitHub Actions
@@ -29,7 +27,7 @@ CONDUCTOR_GITHUB_ACTIONS_WORKFLOW
2927
2. Commit and push the workflow to your main branch of your package repository
3028

3129
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.
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.
30+
We recommend to create a dedicated authentication token with update access. You can copy and paste the contents for the secret from the "Environment variable" tab in the Private Packagist UI while creating the token in "Settings" -> "Authentication Tokens". Remove the single quotes around the value.
3331

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

@@ -39,7 +37,24 @@ The contents of the variable should look like
3937
{"http-basic": {"repo.packagist.com": {"username": "token", "password": "packagist_out_73a81c..." }}}
4038
```
4139

42-
Conductor needs to [verify your CI setup](#verify-your-ci-setup) before you can start receiving pull requests.
40+
Conductor needs to verify your CI setup before you can start receiving pull requests.
41+
42+
## Verify your CI setup
43+
44+
![Task list with verification task](/Resources/public/img/docs/conductor/verification-task-list.png)
45+
46+
Right now all tasks are waiting for the CI verification task on top of the list. Conductor will not start with the regular schedule until this verification task was successful.
47+
The verification task will only execute `composer update nothing` and will not result in a PR to be sent to your code hosting platform.
48+
49+
- Click on the task "Verify the continuous integration setup"
50+
- Use the "Schedule now" button to test your setup
51+
52+
You can see the state of your task and the last events for the task. Once the task is executed, watch your CI platform:
53+
You should see a run for the just added workflow. Examine the run to see if it succeeded.
54+
55+
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.
56+
57+
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.
4358

4459
## How scheduling works
4560

@@ -59,7 +74,7 @@ The workflow consists of several steps:
5974
6. Push commits to a new branch (or force push an existing branch)
6075
7. Send the status of the workflow to Private Packagist
6176

62-
If all these steps succeeded, Private Packagist creates a pull request for the just pushed branch. The PR description will contain details about the update and changelogs from your dependencies. Conductor integrates with [Update Review](https://packagist.com/features/update-review) to present a reviewable list of all updated dependencies.
77+
If all these steps succeeded, Private Packagist creates a pull request for the newly pushed branch. The PR description will contain details about the update and changelogs from your dependencies. Conductor integrates with [Update Review](https://packagist.com/features/update-review) to present a reviewable list of all updated dependencies.
6378

6479
![Conductor Pull Request](https://packagist.com/img/features/auto-updates/merged-PR-for-a-security-updated.png)
6580

@@ -70,19 +85,3 @@ If you want to schedule any other task in the list, click on its name and use th
7085

7186
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.
7287

73-
## Verify your CI setup
74-
75-
![Task list with verification task](/Resources/public/img/docs/conductor/verification-task-list.png)
76-
77-
Right now all tasks are waiting for the CI verification task on top of the list. Conductor will not start with the regular schedule until this verification task was successful.
78-
The verification task will only execute `composer update nothing` and will not result in a PR to be sent to your code hosting platform.
79-
80-
- Click on the task "Verify the continuous integration setup"
81-
- Use the "Schedule now" button to test your setup
82-
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:
84-
You should see a run for the just added workflow. Examine the run if it succeeded.
85-
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.
87-
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)