Skip to content

chore: clarify instruction #60

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
AndyRae merged 1 commit into from
Sep 22, 2026
+8 −2
Merged

chore: clarify instruction #60

Show file tree
Hide file tree
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
Binary file added docs/images/squash-merges.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 4 additions & 1 deletion docs/samples/release.container.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,10 @@ The workflow performs the following steps:

- Your repository must follow [conventional commit](https://conventionalcommits.org/) format
- We recommend `samples/check.pr-title.yaml` to enforce this on pull requests
- Your repository settings should only allow squash merges, and use the PR title as the commit message for commit messages to be correctly parsed by semantic-release
- Your repository settings should ONLY allow squash merges, and use the PR title as the commit message for commit messages to be correctly parsed by semantic-release
![GitHub repository settings](../images/squash-merges.png)


- You need a `samples/release.config.js` in your repository root to configure semantic-release
- You need a `Dockerfile` in your repository root (or update the `dockerfile` parameter)
- You need to follow the relevant language steps
Expand Down
5 changes: 4 additions & 1 deletion docs/samples/release.pypi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,10 @@ The `semantic-release` step can still be a reusable workflow call, and the `publ

- Your repository must follow [conventional commit](https://conventionalcommits.org/) format
- We recommend `samples/check.pr-title.yaml` to enforce this on pull requests
- Your repository settings should only allow squash merges, using the PR title as the commit message so semantic-release can parse it correctly
- Your repository settings should ONLY allow squash merges, using the PR title as the commit message so semantic-release can parse it correctly
![GitHub repository settings](../images/squash-merges.png)


- You need a `release.config.js` in your repository root — copy from `samples/release.config.js` and update `repositoryUrl`
- Your package must be configured to derive its version from git tags (see [Python setup](#python-setup) below)
- You must configure a PyPI trusted publisher for your package (see [PyPI setup](#pypi-trusted-publisher-setup) below)
Expand Down
Loading