diff --git a/.github/workflows/publish-release.yml b/.github/workflows/publish-release.yml index 60f7751..3dc8f68 100644 --- a/.github/workflows/publish-release.yml +++ b/.github/workflows/publish-release.yml @@ -1,3 +1,6 @@ +--- +# This workflow publishes a release when a new tag is created + name: Publish Release on: @@ -31,4 +34,4 @@ jobs: release_name: ${{ github.ref }} body: ${{ steps.changelog.outputs.notes }} draft: false - prerelease: false \ No newline at end of file + prerelease: false diff --git a/.github/workflows/tag-release.yml b/.github/workflows/tag-release.yml index 9a5bdc7..090a015 100644 --- a/.github/workflows/tag-release.yml +++ b/.github/workflows/tag-release.yml @@ -1,3 +1,9 @@ +--- +# This workflow will tag a release whenever a new release is pushed to the main branch +# properly added to the CHANGELOG.md file as a new entry with the following format: +# ## [X.Y.Z] - YYYY-MM-DD + + name: Tag Release on: @@ -27,4 +33,4 @@ jobs: - name: Create Tag run: | git tag ${{ steps.changelog.outputs.version }} - git push origin ${{ steps.changelog.outputs.version }} \ No newline at end of file + git push origin ${{ steps.changelog.outputs.version }} diff --git a/.github/workflows/validate-changelog.yml b/.github/workflows/validate-changelog.yml index 91c115c..c59d9c5 100644 --- a/.github/workflows/validate-changelog.yml +++ b/.github/workflows/validate-changelog.yml @@ -1,3 +1,6 @@ +--- +# This workflow validates that change log has a valid format + name: Validate Changelog on: @@ -17,4 +20,4 @@ jobs: if ! grep -qE '^## \[[0-9]+\.[0-9]+\.[0-9]+\] - [0-9]{4}-[0-9]{2}-[0-9]{2}' CHANGELOG.md; then echo "CHANGELOG format is incorrect, versions should be in the format ## X.Y.Z" exit 1 - fi \ No newline at end of file + fi