Skip to content

Commit

Permalink
DOC: README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
khalford committed Nov 14, 2024
1 parent 18e919d commit 8565e22
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Read here for details: [Link to GitHub docs](https://docs.github.com/en/actions/
The release tag is extracted and stored in `$GITHUB_ENV`,
you can access this in your workflow with `$ {{ env.release_tag }}`

If you are making a change which should not affect the version such as README or CI changes. You can label the pull request with `documentation` or `workflow` and the version checks will be skipped.

<!-- start usage -->
```yaml
- name: Checkout main
Expand All @@ -43,12 +45,13 @@ you can access this in your workflow with `$ {{ env.release_tag }}`
# Don't run on main otherwise it will compare main with main
if: ${{ github.ref != 'refs/heads/main' }}
id: version_comparison
uses: khalford/check-version-action@main
uses: stfc/check-version-action@main
with:
# Path to version file from project root
app_version_path: "version.txt"
# Optional: To check if compose image version matches application version
docker_compose_path: "docker-compose.yaml"
labels: ${{ toJSON(github.event.pull_request.labels.*.name) }}

- name: Log App Success
if: ${{ env.app_updated == 'true' }}
Expand Down

0 comments on commit 8565e22

Please sign in to comment.