You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# When generating release notes, setting the target tag_name property to an existing tag has GitHub ignore the target_commitish property
297
-
# So, set the tag name to the target commit to generate release notes from the last semver tag to the target commit
298
-
# See https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#generate-release-notes-content-for-a-release--parameters
299
-
# Note the following _does not change releases or tags_ - it only creates release notes, just like clicking "Generate Release Notes" on the GitHub Releases page.
@@ -229,6 +230,10 @@ Use conventional commit format (feat:, fix:, chore:, etc.) for commit titles.
229
230
5. Run `slack docgen ./docs/reference` to generate docs
230
231
6. Consider adding command alias in `AliasMap` if appropriate
231
232
233
+
### Command Descriptions and Documentation
234
+
235
+
Command `Long` descriptions are parsed as Go `text/template` by `docgen` and rendered as MDX for the documentation site. Escape `{` and `[` as `\{` and `\[` in description text to prevent build errors on the docs site. Available template functions: `{{Emoji "name"}}`, `{{LinkText "url"}}`, `{{ToBold "text"}}`.
- [ ] Confirm unit tests and E2E tests are passing on the [`main`](https://github.com/slackapi/slack-cli/commits/main) branch.
118
+
- [ ] Confirm unit tests and E2E tests are passing on this PR.
119
+
- [ ] Confirm the [dev-build](https://github.com/slackapi/slack-cli/releases/tag/dev-build) includes all commits since last release.
120
+
- [ ] Review open issues or PRs on the "[Next Release](https://github.com/slackapi/slack-cli/milestones)" milestone.
121
+
- [ ] Confirm the new version matches the expected next version.
122
+
123
+
### Reviewers
124
+
125
+
After merging, create a [GitHub Release](https://github.com/${{ github.repository }}/releases/new?tag=v${RELEASE_VERSION}&title=v${RELEASE_VERSION}) to tag the new version.
126
+
127
+
### Requirements
128
+
129
+
- [x] I've read and understood the [Contributing Guidelines](https://github.com/slackapi/slack-cli/blob/main/.github/CONTRIBUTING.md) and have done my best effort to follow them.
130
+
- [x] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct).
131
+
EOF
132
+
)
133
+
134
+
# Check if a PR from rc already exists
135
+
EXISTING_PR=$(gh pr list --head rc --base main --json number --jq '.[0].number' 2>/dev/null || true)
0 commit comments