diff --git a/docs/images/squash-merges.png b/docs/images/squash-merges.png new file mode 100644 index 0000000..8bcd9d7 Binary files /dev/null and b/docs/images/squash-merges.png differ diff --git a/docs/samples/release.container.md b/docs/samples/release.container.md index f09c3fb..aaaff0e 100644 --- a/docs/samples/release.container.md +++ b/docs/samples/release.container.md @@ -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 diff --git a/docs/samples/release.pypi.md b/docs/samples/release.pypi.md index 99b4252..ff14b21 100644 --- a/docs/samples/release.pypi.md +++ b/docs/samples/release.pypi.md @@ -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)