Skip to content

docs(github-actions): add packages-dir configuration in monorepo example #1229

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
merged 2 commits into from
Apr 18, 2025
Merged

docs(github-actions): add packages-dir configuration in monorepo example #1229

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cca2b22
docs(github-actions): add packages-dir configuration in monorepo example
timonrieger Apr 6, 2025
1b86587
docs(github-actions): expound on monorepo example to include publishi…
codejedi365 Apr 18, 2025
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
95 changes: 80 additions & 15 deletions docs/automatic-releases/github-actions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -734,17 +734,17 @@ to the GitHub Release Assets as well.
git_committer_name: "github-actions"
git_committer_email: "actions@users.noreply.github.com"

- name: Publish | Upload package to PyPI
uses: pypa/gh-action-pypi-publish@v1
if: steps.release.outputs.released == 'true'

- name: Publish | Upload to GitHub Release Assets
uses: python-semantic-release/publish-action@v9.21.0
if: steps.release.outputs.released == 'true'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
tag: ${{ steps.release.outputs.tag }}

- name: Publish | Upload package to PyPI
uses: pypa/gh-action-pypi-publish@SHA1_HASH # vX.X.X
if: steps.release.outputs.released == 'true'

.. important::
The `concurrency`_ directive is used on the job to prevent race conditions of more than
one release job in the case if there are multiple pushes to ``main`` in a short period
Expand Down Expand Up @@ -816,19 +816,84 @@ For multiple packages, you would need to run the action multiple times, to relea
each project. The following example demonstrates how to release two projects in
a monorepo.

Remember that for each release of each submodule you will then need to handle publishing
each package separately as well. This is dependent on the result of your build commands.
In the example below, we assume a simple ``build`` module command to build a ``sdist``
and wheel artifacts into the submodule's ``dist`` directory.

The ``directory`` input directive is also available for the Python Semantic Release
Publish Action.

.. code:: yaml

- name: Release Project 1
uses: python-semantic-release/python-semantic-release@v9.21.0
with:
directory: ./project1
github_token: ${{ secrets.GITHUB_TOKEN }}

- name: Release Project 2
uses: python-semantic-release/python-semantic-release@v9.21.0
with:
directory: ./project2
github_token: ${{ secrets.GITHUB_TOKEN }}
jobs:

release:

env:
SUBMODULE_1_DIR: project1
SUBMODULE_2_DIR: project2

steps:

# ------------------------------------------------------------------- #
# Note the use of different IDs to distinguish which submodule was #
# identified to be released. The subsequent actions then reference #
# their specific release ID to determine if a release occurred. #
# ------------------------------------------------------------------- #

- name: Release submodule 1
id: release-submod-1
uses: python-semantic-release/python-semantic-release@v9.21.0
with:
directory: ${{ env.SUBMODULE_1_DIR }}
github_token: ${{ secrets.GITHUB_TOKEN }}

- name: Release submodule 2
id: release-submod-2
uses: python-semantic-release/python-semantic-release@v9.21.0
with:
directory: ${{ env.SUBMODULE_2_DIR }}
github_token: ${{ secrets.GITHUB_TOKEN }}

# ------------------------------------------------------------------- #
# For each submodule, you will have to publish the package separately #
# and only attempt to publish if the release for that submodule was #
# deemed a release (and the release was successful). #
# ------------------------------------------------------------------- #

- name: Publish | Upload package 1 to GitHub Release Assets
uses: python-semantic-release/publish-action@v9.21.0
if: steps.release-submod-1.outputs.released == 'true'
with:
directory: ${{ env.SUBMODULE_1_DIR }}
github_token: ${{ secrets.GITHUB_TOKEN }}
tag: ${{ steps.release-submod-1.outputs.tag }}

- name: Publish | Upload package 2 to GitHub Release Assets
uses: python-semantic-release/publish-action@v9.21.0
if: steps.release-submod-2.outputs.released == 'true'
with:
directory: ${{ env.SUBMODULE_2_DIR }}
github_token: ${{ secrets.GITHUB_TOKEN }}
tag: ${{ steps.release-submod-2.outputs.tag }}

# ------------------------------------------------------------------- #
# Python Semantic Release is not responsible for publishing your #
# python artifacts to PyPI. Use the official PyPA publish action #
# instead. The following steps are an example but is not guaranteed #
# to work as the action is not maintained by the #
# python-semantic-release team. #
# ------------------------------------------------------------------- #

- name: Publish | Upload package 1 to PyPI
uses: pypa/gh-action-pypi-publish@SHA1_HASH # vX.X.X
if: steps.release-submod-1.outputs.released == 'true'
with:
packages-dir: ${{ format('{}/dist', env.SUBMODULE_1_DIR) }}

- name: Publish | Upload package 2 to PyPI
uses: pypa/gh-action-pypi-publish@SHA1_HASH # vX.X.X
if: steps.release-submod-2.outputs.released == 'true'
with:
packages-dir: ${{ format('{}/dist', env.SUBMODULE_2_DIR) }}