Hello,
the documentation chapter Github Actions starts with explaining the GitHub Actions, then link to: action.yml - which is the definition for the action in github - endusers don't care about it, I guess - and then all configuration options are shown.
After this the practical example sections comes, but one doesn't know that it will follow. It's not shown in the side-navigation.
Improvments:
- link in the top description to "#examples" .
- give two short examples directly on how to create a version and how to publish a build.
- name: Release | Python Semantic Release
id: release
uses: python-semantic-release/python-semantic-release@10 # which version???
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
verbosity: 1
build: false
# all the documented options here... - name: Release | Add distribution artifacts to GitHub Release Assets
uses: python-semantic-release/publish-action@10 # which version???
if: steps.release.outputs.released == 'true'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
tag: ${{ steps.release.outputs.tag }}
Hello,
the documentation chapter Github Actions starts with explaining the GitHub Actions, then link to: action.yml - which is the definition for the action in github - endusers don't care about it, I guess - and then all configuration options are shown.
After this the practical example sections comes, but one doesn't know that it will follow. It's not shown in the side-navigation.
Improvments: