Skip to content

docs(github-actions): adjust documentation for direct links to action example workflows #1309

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
codejedi365 merged 1 commit into from
Aug 6, 2025
Merged

docs(github-actions): adjust documentation for direct links to action example workflows #1309

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/configuration/automatic-releases/github-actions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@ There are two official GitHub Actions for Python Semantic Release:
It is used to upload files, such as distribution artifacts and other assets,
to a GitHub release.

Included in this documentation are some recommended examples below if you want to get
started quickly. These examples are not exhaustive and you will need to adjust them
for your specific project needs especially if you are using a monorepo.

- :ref:`GitHub Actions Example Workflows <gh_actions-examples>`

- :ref:`GitHub Actions with Monorepos <gh_actions-monorepo>`

.. note::
These GitHub Actions are only simplified wrappers around the
python-semantic-release CLI. Ultimately, they download and install the
Expand Down