| Version | Latest Commit | Nightly Build |
|---|---|---|
main |
 |
 |
v1 |
 |
 |
Build a Composer Satis repository and output the final build to a GitHub artifact.
For private GitHub repositories you can pass a token through using the composer-token input. This sets the
composer github-oauth token within the runner and allows private repositories to be added to the Satis config file.
You can use the minimal example below within your own workflow to get up and running.
jobs:
build-satis-repo:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- id: generate-satis-repo
name: 'Run Generate Satis Repository Action'
uses: mattgrul/satis-to-artifact-action@v1
env:
SATIS_PATH: ${{ github.workspace }}/satisFor a more configurable use case of using the action with all the available inputs see the example below.
jobs:
build-satis-repo:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- id: generate-satis-repo
name: 'Run Generate Satis Repository Action'
uses: mattgrul/satis-to-artifact-action@v1
with:
composer-token: ${{ secrets.SECRET_NAME }}
composer-version: 2.2 # Composer version 2.2
php-version: 8.1 # PHP version 8.1
satis-version: fafc1c2eca6394235f12f8a3ee4da7fc7c9fc874 # Satis from the commit SHA fafc1c2eca6394235f12f8a3ee4da7fc7c9fc874
satis-config: build # The Satis config file from the `build` directory
cache-composer: false # Disable caching of the Composer cache directory
artifact-name: my-composer-repo #Output the final build to an artifact named `my-composer-repo`
retention-days: 30 # Keep the artifact for 30 days
repository-url: https://github.com/OWNER/REPO # Only scan and update packages in this repository
env:
SATIS_PATH: ${{ github.workspace }}/satisThere are 7 input values that can be configured for the action which are as follows:
| Name | Required | Default | Description |
|---|---|---|---|
| php-version | No | 8.3 | The PHP version to use |
| composer-token | No | ${{github.token}} |
The GitHub token to use |
| composer-version | No | 2.6 | The Composer version to use |
| satis-version | No | main | The version of Satis to use |
| satis-config | No | null |
The path to the Satis config file |
| cache-composer | No | true | Whether or not to cache the composer files |
| artifact-name | No | modules-repository-build | The name of the final artifact |
| retention-days | No | 90 | The duration to keep the final build artifact |
| repository-url | No | null |
The duration to keep the final build artifact |
This action uses shivammathur/setup-php to control PHP and Composer versions.
For supported versions of PHP please see the Setup PHP in GitHub Actions.
The latest stable version of composer is set up by default. You can set up the required composer version by specifying the major version v1 or v2, or the version in major.minor or semver format. Additionally, for composer snapshot a preview can also be specified to set up the respective releases.
If you need to access private repositories you can pass a token through using the composer-token input. The token
should be created as a secret and passed through securely, for example composer-token: ${{ secrets.SECRET_NAME }}. For
more information on creating a secret see
the GitHub documentation.
By default, the action uses the token `${{ github.token if no composer-token is provided which will allow access to the repository the action is running on.
Caching of the Composer cache directory is enabled by default, which speeds up the action by reusing the Composer files between runs. This behavior can be toggled with the cache-composer input.
The name of the final artifact is suffixed with ${{ github.run_id }} to ensure each workflow keeps its original copy
of the repository build. For example, modules-repository-build-1234567890.
By default, GitHub will keep artifacts for 90 days. This can be changed by setting the retention-days input value to
your specified time e.g. 30 for 30 days.
The latest stable version of Satis is used by default using the branch main.
If you need a specific version of Satis to be compatible with an older version of Composer for example, you can set up
the required Satis version by specifying the commit SHA from the Satis repository using the satis-version input value.
with:
satis-version: e4982dc3037fdc14402c3e080556a172d276463aAn example Satis config file can be found below. The default location for the config file is satis.json in the root of
the repository.
{
"name": "My Repository",
"homepage": "http://packages.example.org",
"repositories": [
{
"type": "vcs",
"url": "https://github.com/mycompany/privaterepo"
}
],
"require-all": true
}The location of this config file can be changed by adding the satis-config input value relative to the root, for
example if you
placed the config file in a build directory within the repository root you can use satis-config: build as an input.
with:
satis-config: buildTo speed up the build process you can use the repository-url input value to only scan and update the packages in a
specific repository. This should be the full URL of the repository to scan and update, for
example, https://github.com/OWNER/REPO and should be within the satis.json config file.
There is 1 output for the action.
| Name | Description |
|---|---|
| satis-artifact | The name of the Satis Repository artifact |
If the upload-artifact step does not find a file to upload, an error is returned and the action will fail without
setting the output. This allows you to use the ${{ success() }} expression on subsequent steps or the needs
condition on subsequent jobs.
The satis-artifact output can be useful if you want to deploy the artifact to a remote server for example.
For example if you had the below generate-satis-repo step in your workflow you could use the satis-artifact output
to download the artifact in a subsequent step like so.
- id: generate-satis-repo
name: 'Run Generate Satis Repository Action'
uses: mattgrul/satis-to-artifact-action@v1
env:
SATIS_PATH: ${{ github.workspace }}/satis
- id: download-artifact
if: ${{ success() }}
uses: actions/download-artifact@v3
with:
name: ${{ steps.generate-satis-repo.outputs.satis-artifact }}There is one environment variable that can be configured for the action which is the location of the Satis install on the job's runner:
env:
SATIS_PATH: ${{ github.workspace }}/satisThis action follows Semantic Versioning for releases and will be associated with a matching tag.
It is recommended to use dependabot with semantic versioning to keep the actions in your workflows up to date.
Depending on your preference for receiving updates, you can use any of the following tags. Note that major and minor version tags, such as v1 and v1.1, are rolling tags and synced with the latest minor and patch releases.
mattgrul/satis-to-artifact-action@v1- Suitable for receiving all updates in thev1range (up tov1.x.x).mattgrul/satis-to-artifact-action@v1.0- Suitable for receiving all updates in thev1.0.xrange. =mattgrul/satis-to-artifact-action@v1.1.2- Pins to the specific v1.1.2 patch version.
If you would like to pin to a specific commit for compatibility reasons you can use a specific commit SHA which are immutable.
mattgrul/satis-to-artifact-action@e4982dc3037fdc14402c3e080556a172d276463a- Will use a specific commit version.
Although it is not guaranteed to be stable and should be used with caution, you can get the latest version by using the
branch main such as mattgrul/satis-to-artifact-action@main.
This action depends on the following actions:
- shivammathur/setup-php@v2 - This action is used to set up PHP and Composer versions.
- actions/cache@v3 - This action is used to cache the Satis install directory between runs.
All contributions are welcome! Please see the Contributing Guide for more details.