Actions/ci
1
0
Fork 0
mirror of https://github.com/DeterminateSystems/ci.git synced 2025-06-04 08:47:06 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request from DeterminateSystems/options-table

Browse source 
Document configuration options and outputs
This commit is contained in:
Graham Christensen 2025-04-18 19:55:00 -04:00 • committed by GitHub
commit c7bcdb4d0b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 46 additions and 6 deletions
.github/workflows
workflow.yml
README.md

23
.github/workflows/workflow.yml vendored
View file

@ -2,26 +2,37 @@ on:
workflow_call: workflow_call:
inputs: inputs:
visibility: visibility:
description: |
`public`, `unlisted`, or `private` ([private flakes](https://docs.determinate.systems/flakehub/private-flakes) are available only on a [FlakeHub paid plan](https://flakehub.com/signup)).
required: false required: false
type: string type: string
default-branch: default-branch:
description: |
The [default Git branch](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch) for the repository.
required: false required: false
default: ${{ github.event.repository.default_branch }} default: ${{ github.event.repository.default_branch }}
type: string type: string
enable-ssh-agent: enable-ssh-agent:
description: |
Whether to enable [`webfactory/ssh-agent`](https://github.com/webfactory/ssh-agent) in the workflow. If you set this to `true` you need to supply a secret named `ssh-private-key`.
required: false required: false
default: false default: false
type: boolean type: boolean
directory: directory:
description: |
The root directory of your flake.
required: false required: false
default: "." default: "."
type: string type: string
fail-fast: fail-fast:
description: |
Whether to cancel all in-progress jobs if any matrix job fails
required: false required: false
default: true default: true
type: boolean type: boolean
description: "Whether to cancel all in-progress jobs if any matrix job fails"
runner-map: runner-map:
description: |
A custom mapping of [Nix system types](https://zero-to-nix.com/concepts/system-specificity) to desired Actions runners
required: false required: false
type: string type: string
default: | default: |
@ -36,21 +47,21 @@ on:
flake_name: flake_name:
value: ${{ jobs.success.outputs.flake_name }} value: ${{ jobs.success.outputs.flake_name }}
description: | description: |
Name of the flake. The name of the flake.
Example: DeterminateSystems/flakehub-push Example: `DeterminateSystems/flakehub-push`
flake_version: flake_version:
value: ${{ jobs.success.outputs.flake_version }} value: ${{ jobs.success.outputs.flake_version }}
description: | description: |
Version of the published flake. Version of the published flake.
Example: 0.1.99+rev-2075013a3f3544d45a96f4b35df4ed03cd53779c Example: `0.1.99+rev-2075013a3f3544d45a96f4b35df4ed03cd53779c`
flakeref_exact: flakeref_exact:
value: ${{ jobs.success.outputs.flakeref_exact }} value: ${{ jobs.success.outputs.flakeref_exact }}
description: | description: |
A precise reference that always resolves to this to this exact release. A precise reference that always resolves to this to this exact release.
Example: DeterminateSystems/flakehub-push/=0.1.99+rev-2075013a3f3544d45a96f4b35df4ed03cd53779c Example: `DeterminateSystems/flakehub-push/=0.1.99+rev-2075013a3f3544d45a96f4b35df4ed03cd53779c`
flakeref_at_least: flakeref_at_least:
value: ${{ jobs.success.outputs.flakeref_at_least }} value: ${{ jobs.success.outputs.flakeref_at_least }}
description: | description: |
@ -58,7 +69,7 @@ on:
Depending on this reference will require at least this version, and will also resolve to newer releases. Depending on this reference will require at least this version, and will also resolve to newer releases.
This output is not sufficient for deployment pipelines, use flake_exact instead. This output is not sufficient for deployment pipelines, use flake_exact instead.
Example: DeterminateSystems/flakehub-push/0.1.99+rev-2075013a3f3544d45a96f4b35df4ed03cd53779c Example: `DeterminateSystems/flakehub-push/0.1.99+rev-2075013a3f3544d45a96f4b35df4ed03cd53779c`
secrets: secrets:
ssh-private-key: ssh-private-key:

29
README.md
View file

@ -49,6 +49,21 @@ You'll see something like this when your workflow has run successfully:
![Screenshot of successful build](https://github.com/DeterminateSystems/ci/assets/76716/c2c6aa07-3fd3-4e66-9440-bef264b472da) ![Screenshot of successful build](https://github.com/DeterminateSystems/ci/assets/76716/c2c6aa07-3fd3-4e66-9440-bef264b472da)
## Configuration options
| Parameter | Description | Default |
| :----------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `visibility` | `public`, `unlisted`, or `private` ([private flakes][private-flakes] are available only on a [FlakeHub paid plan][signup]) | |
| `default-branch` | The [default Git branch][default-branch] for the repository | `${{ github.event.repository.default_branch }}` |
| `enable-ssh-agent` | Whether to enable [`webfactory/ssh-agent`][ssh-agent] in the workflow. If you set this to `true` you need to supply a secret named `ssh-private-key`. | `false` |
| `directory` | The root directory of your flake. | `.` |
| `fail-fast` | Whether to cancel all in-progress jobs if any matrix job fails | `true` |
| `runner-map` | A custom mapping of [Nix system types][nix-system] to desired Actions runners | `{ "aarch64-darwin": "macos-latest", "x86_64-darwin": "macos-latest", "x86_64-linux": "ubuntu-latest", "i686-linux": "ubuntu-latest", "aarch64-linux": "ubuntu-latest" }` |
## Example configurations
The sections below show configurations for some common use cases.
### Publishing to FlakeHub ### Publishing to FlakeHub
Publish to FlakeHub on every push to the default branch and on every tag. Publish to FlakeHub on every push to the default branch and on every tag.
@ -187,16 +202,29 @@ jobs:
fail-fast: false fail-fast: false
``` ```
## Workflow outputs
The `DeterminateSystems/ci` workflow provides a number of outputs that you can use in dependent workflows.
| Output | Description | Example |
| :------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `flake_name` | The name of the flake | `DeterminateSystems/flakehub-push` |
| `flake_version` | The version of the published flake | `0.1.99+rev-2075013a3f3544d45a96f4b35df4ed03cd53779c` |
| `flakeref_exact` | A precise flake reference that always resolves to this to this exact release. | `DeterminateSystems/flakehub-push/=0.1.99+rev-2075013a3f3544d45a96f4b35df4ed03cd53779c` |
| `flakeref_at_least` | A loose reference to this release. Depending on this reference will require at least this version, and will also resolve to newer releases. This output is not sufficient for deployment pipelines, use flake_exact instead. | ``DeterminateSystems/flakehub-push/0.1.99+rev-2075013a3f3544d45a96f4b35df4ed03cd53779c` |
## Notes ## Notes
This workflow uses a collection of GitHub Actions by Determinate Systems, all of which are covered by the Determinate Systems [privacy policy][privacy] and [terms of service][tos]. This workflow uses a collection of GitHub Actions by Determinate Systems, all of which are covered by the Determinate Systems [privacy policy][privacy] and [terms of service][tos].
[binary-cache]: https://zero-to-nix.com/concepts/caching [binary-cache]: https://zero-to-nix.com/concepts/caching
[cache]: https://flakehub.com/cache [cache]: https://flakehub.com/cache
[default-branch]: https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch
[flake-schemas]: https://github.com/DeterminateSystems/flake-schemas [flake-schemas]: https://github.com/DeterminateSystems/flake-schemas
[flakehub]: https://flakehub.com/ [flakehub]: https://flakehub.com/
[discord]: https://determinate.systems/discord [discord]: https://determinate.systems/discord
[nix]: https://zero-to-nix.com [nix]: https://zero-to-nix.com
[nix-system]: https://zero-to-nix.com/concepts/system-specificity
[privacy]: https://determinate.systems/policies/privacy [privacy]: https://determinate.systems/policies/privacy
[private-flakes]: https://docs.determinate.systems/flakehub/private-flakes [private-flakes]: https://docs.determinate.systems/flakehub/private-flakes
[publishing]: https://docs.determinate.systems/flakehub/publishing [publishing]: https://docs.determinate.systems/flakehub/publishing
@ -205,6 +233,7 @@ This workflow uses a collection of GitHub Actions by Determinate Systems, all of
[runners-large-macos]: https://docs.github.com/en/actions/using-github-hosted-runners/using-larger-runners/about-larger-runners#about-macos-larger-runners [runners-large-macos]: https://docs.github.com/en/actions/using-github-hosted-runners/using-larger-runners/about-larger-runners#about-macos-larger-runners
[runners-linux-arm]: https://github.blog/changelog/2025-01-16-linux-arm64-hosted-runners-now-available-for-free-in-public-repositories-public-preview/ [runners-linux-arm]: https://github.blog/changelog/2025-01-16-linux-arm64-hosted-runners-now-available-for-free-in-public-repositories-public-preview/
[signup]: https://flakehub.com/signup [signup]: https://flakehub.com/signup
[ssh-agent]: https://github.com/webfactory/ssh-agent
[tos]: https://determinate.systems/policies/terms-of-service [tos]: https://determinate.systems/policies/terms-of-service
[visibility]: https://docs.determinate.systems/flakehub/concepts/visibility [visibility]: https://docs.determinate.systems/flakehub/concepts/visibility
[workflow-access]: https://docs.github.com/en/actions/sharing-automations/reusing-workflows#using-self-hosted-runners [workflow-access]: https://docs.github.com/en/actions/sharing-automations/reusing-workflows#using-self-hosted-runners