Skip to content

docs: clarify boilerplates-ref checkout order #62

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

Open
kitsuyui wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify boilerplates-ref checkout order #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ GitHub-hosted runners satisfy all of the above requirements out of the box.
| --- | --- | --- |
| `version` | (action pin) | gibo release tag (e.g. `v3.0.22`). Leave empty to use the version pinned by the action. |
| `update` | `'true'` | Run `gibo update` after install. Set to `'false'` to skip the unconditional database refresh, e.g. when caching the boilerplates database externally. |
| `boilerplates-ref` | `''` | Optional git ref to check out in the boilerplates database after `gibo update`. Use a commit SHA to make later `gibo dump` output reproducible. |
| `boilerplates-ref` | `''` | Optional git ref to check out in the boilerplates database. With `update: 'true'`, the action updates before checkout; with `update: 'false'`, it checks out from the database already present on the runner. Use a commit SHA to make later `gibo dump` output reproducible. |

## Outputs

Expand All @@ -61,7 +61,9 @@ GitHub-hosted runners satisfy all of the above requirements out of the box.

By default, `gibo update` follows the current upstream boilerplates database
HEAD. Pin `boilerplates-ref` to a commit SHA when downstream steps need
byte-reproducible `gibo dump` output:
byte-reproducible `gibo dump` output. The checkout runs after any requested
update, or from the database already present on the runner when `update` is
`'false'`:

```yaml
steps:
Expand Down
7 changes: 5 additions & 2 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,11 @@ inputs:
description: |
Optional git ref for the boilerplates database. When set, the
action resolves the ref in the `gibo root` directory and checks
it out after `gibo update`, making later `gibo dump` output
reproducible for the selected database commit.
it out before reporting outputs. With `update: 'true'`, the
checkout happens after `gibo update`; with `update: 'false'`,
it uses the database already present on the runner. This makes
later `gibo dump` output reproducible for the selected database
commit.
A full 40-character commit SHA is resolved from the local
database without a network fetch; the same SHA always points
to the same object, so `gibo dump` output is stable across
Expand Down