Skip to content

Conductor: explain COMPOSER_SKIP_SCRIPTS #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 14, 2025
Merged

Conductor: explain COMPOSER_SKIP_SCRIPTS #125

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
372818e
Explain `COMPOSER_SKIP_SCRIPTS` env var
stevenrombauts Mar 12, 2025
05a272c
Update docs/conductor/getting-started.md
stevenrombauts Mar 14, 2025
794f946
Rephrase example line
stevenrombauts Mar 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/conductor/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 in your `post-install-cmd` script you can update your GitHub action to skip it:

```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
installs the latest version.

## Verify your CI setup

- Navigate to the "Conductor" tab in your Private Packagist organization.
Expand Down