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
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,28 +1,28 @@
1
1
# Getting started with Conductor
2
2
##
3
3
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.
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.
5
5
6
-
To use Conductor:
6
+
Prerequisites for receiving dependency update PRs from Conductor:
7
7
8
-
-You need to be approved for early access to Conductor. [Join the waitlist](/features/conductor) and wait for approval.
9
-
-You need a Private Packagist trial or subscription on the cloud plan.
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.
8
+
-Receive early access to Conductor. [Join the waitlist](/features/conductor) and wait for approval.
9
+
-Set up an organization on Private Packagist Cloud either with a free trial or subscribe to the cloud plan.
10
+
-A synchronization in your Private Packagist organization with your code hosting platform.
11
+
-A workflow on your continuous integration platform to run Composer updates.
12
12
13
-
## Add a synchronization
13
+
## Set up synchronization
14
14
15
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
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.
17
+
This is how you grant us access to your VCS repositories. The synchronization will automatically add any repository with a composer.json file in the root directory as a package to Private Packagist.
18
18
19
19
## Configure Conductor for your packages
20
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 can receive pull requests from Conductor. This usually includes all your Composer projects.
23
-
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
+
Access the "Conductor" tab in the main navigation to see a list of available packages that can have their dependencies updated by Conductor.
22
+
Each package shown is linked to its VCS repository to which Conductor will send pull requests with dependency updates. Your Composer projects or applications are also a kind of package and must be added to Private Packagist as regular packages to use Conductor on them.
23
+
Conductor can only 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.
24
24
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.
25
+
To get started, click on the configure link displayed next to the package which you would like Conductor to update. Follow the instructions for your continuous integration platform.
26
26
27
27
### GitHub Actions
28
28
@@ -38,7 +38,7 @@ We recommend to create a dedicated authentication token with update access. You
Once you reviewed the changes and merged the PR, Conductor will schedule the next task.
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.
89
+
If you close the PR, the task will be paused and Conductor will schedule the next task. Clicking the "Pause" button in the UI has the same effect. Conductor won't attempt to update the dependency to this exact version again but it will schedule updates to newer versions.
90
90
91
91
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".
0 commit comments