workflows

Reusable GitHub Actions workflows for fish-shop projects.

Calling Reusable Workflows

Call reusable workflows with the uses keyword directly within a job, using the syntax fish-shop/workflows/.github/workflows/{filename}@{ref}. For example:

jobs:
  release-tags:
    uses: fish-shop/workflows/.github/workflows/release-tags.yml@v1

Available Workflows

Name	Description
dependency-review.yml	Scan pull requests for dependency changes and raise an error if vulnerabilities or invalid licenses are introduced.
markdown-links.yml	Check for broken hyperlinks in Markdown files.
release-tags.yml	Create major and major-minor release tags (i.e. vX and vX.Y) for tags matching the format vX.Y.Z.

Workflow Versions

Use one of the following patterns when specifying the version reference for workflows (i.e. the {ref} value in uses: fish-shop/workflows/.github/workflows/{filename}@{ref}):

Pattern	Example	Description
vX	v1	the latest v1.* release including non-breaking changes and bug fixes
vX.Y	v1.1	the latest v1.1.* release including bug fixes
vX.Y.Z	v1.1.0	the v1.1.0 release only

The recommended pattern is vX (e.g. v1). This will ensure that the version of the workflow used includes the latest non-breaking changes and bug fixes, and guarantees compatibility with previous versions of that major release number.

Using a main branch reference is not recommended as this branch may include breaking changes intended for the next major release.

License

This project is provided under the terms of the MIT License.

Contact

Email me at marc.ransome@fidgetbox.co.uk or create an issue. Alternatively, refer to the official discussions board.