Skip to content

Commit

Permalink
MAINT: Remove log success from the action
Browse files Browse the repository at this point in the history
We don't need to log the success as we only care if the action fails
  • Loading branch information
khalford committed Jan 29, 2025
1 parent 8cf258a commit 19c85c9
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 25 deletions.
10 changes: 0 additions & 10 deletions .github/workflows/self_test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,3 @@ jobs:
app_version_path: "version.txt"
docker_compose_path: "docker-compose.yml"
labels: ${{ toJSON(github.event.pull_request.labels.*.name) }}

- name: Log Success
if: ${{ env.app_updated == 'true' }}
run: |
echo "App version has been updated correctly!"
- name: Log Success
if: ${{ env.compose_updated == 'true' }}
run: |
echo "Compose version has been updated correctly!"
19 changes: 4 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
[![codecov](https://codecov.io/gh/stfc/check-version-action/graph/badge.svg?token=OD2Z90ST8R)](https://codecov.io/gh/stfc/check-version-action)


This action compares the application version number from your working branch to the main branch.
This action compares the app version number from your working branch to the main branch.

You can also check that the **first** image version that appears in your `docker-compose.yaml` file will match the application version
You can also check that the **first** image version that appears in your `docker-compose.yaml` file matches the app version

The comparison follows the PEP 440 Version Identification and Dependency Specification.

Expand Down Expand Up @@ -42,27 +42,16 @@ If you are making a change which should not affect the version such as README or
path: 'branch'

- name: Compare versions
# Don't run on main otherwise it will compare main with main
# Don't run on main otherwise it compares main with main
if: ${{ github.ref != 'refs/heads/main' }}
id: version_comparison
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
# Optional: to check if Docker compose image version matches app version
docker_compose_path: "docker-compose.yaml"
labels: ${{ toJSON(github.event.pull_request.labels.*.name) }}

- name: Log App Success
if: ${{ env.app_updated == 'true' }}
run: |
echo "App version has been updated correctly!"
# Optional: If using the docker compose check
- name: Log Compose Success
if: ${{ env.compose_updated == 'true' }}
run: |
echo "Compose version has been updated correctly!"
```
<!-- end usage -->

0 comments on commit 19c85c9

Please sign in to comment.