From 372818e5b46de004e8bf9eba3109fe0cf1df6a19 Mon Sep 17 00:00:00 2001 From: Steven Rombauts Date: Wed, 12 Mar 2025 17:18:35 +0100 Subject: [PATCH 1/3] Explain `COMPOSER_SKIP_SCRIPTS` env var --- docs/conductor/getting-started.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/conductor/getting-started.md b/docs/conductor/getting-started.md index 6458e773..4f904e55 100644 --- a/docs/conductor/getting-started.md +++ b/docs/conductor/getting-started.md @@ -40,6 +40,23 @@ Similar to organization authentication tokens, access can be restricted to any s Once the workflow is added to your GitHub repository, Conductor needs to verify your CI setup before you can start receiving PRs. +### Skip Composer scripts + +If you've configured Composer to run scripts for certain events that make changes which are irrelevant for the Conductor PR, you can skip +these script handlers by setting the [COMPOSER_SKIP_SCRIPTS](https://getcomposer.org/doc/03-cli.md#composer-skip-scripts) environment variable. + +For example, if you use `npm` to build static assets when the `post-install-cmd` command event is triggered, update your GitHub action like this: + +```yaml +- name: "Running Conductor" + uses: packagist/conductor-github-action@v1 + env: + COMPOSER_SKIP_SCRIPTS: "post-install-cmd" +``` + +Please note that this feature is only available since [Composer 2.8.6](https://github.com/composer/composer/releases/tag/2.8.6), so make sure your CI +install the latest version. + ## Verify your CI setup - Navigate to the "Conductor" tab in your Private Packagist organization. From 05a272c2c83d3f12c44b44ea3d80049a97bc8086 Mon Sep 17 00:00:00 2001 From: Steven Rombauts Date: Fri, 14 Mar 2025 09:40:18 +0100 Subject: [PATCH 2/3] Update docs/conductor/getting-started.md Co-authored-by: Philipp Scheit --- docs/conductor/getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conductor/getting-started.md b/docs/conductor/getting-started.md index 4f904e55..dde6ce9e 100644 --- a/docs/conductor/getting-started.md +++ b/docs/conductor/getting-started.md @@ -55,7 +55,7 @@ For example, if you use `npm` to build static assets when the `post-install-cmd` ``` Please note that this feature is only available since [Composer 2.8.6](https://github.com/composer/composer/releases/tag/2.8.6), so make sure your CI -install the latest version. +installs the latest version. ## Verify your CI setup From 794f94673f9b88f839a9800e34074e37b5858042 Mon Sep 17 00:00:00 2001 From: Steven Rombauts Date: Fri, 14 Mar 2025 09:41:11 +0100 Subject: [PATCH 3/3] Rephrase example line Co-authored-by: Philipp Scheit --- docs/conductor/getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conductor/getting-started.md b/docs/conductor/getting-started.md index dde6ce9e..840051ea 100644 --- a/docs/conductor/getting-started.md +++ b/docs/conductor/getting-started.md @@ -45,7 +45,7 @@ Once the workflow is added to your GitHub repository, Conductor needs to verify If you've configured Composer to run scripts for certain events that make changes which are irrelevant for the Conductor PR, you can skip these script handlers by setting the [COMPOSER_SKIP_SCRIPTS](https://getcomposer.org/doc/03-cli.md#composer-skip-scripts) environment variable. -For example, if you use `npm` to build static assets when the `post-install-cmd` command event is triggered, update your GitHub action like this: +For example, if you use `npm` to build static assets in your `post-install-cmd` script you can update your GitHub action to skip it: ```yaml - name: "Running Conductor"