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
Copy file name to clipboardExpand all lines: .github/maintainers_guide.md
+17-25Lines changed: 17 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -123,15 +123,16 @@ It is possible to deploy this project on <https://test.pypi.org/> in order to tr
123
123
- Note that the `dev` version can be bumped in development releases: `1.3.0.dev0` ->`1.3.0.dev1`
124
124
- Commit with a message including the new version number. For example `1.3.0.dev0`& Push the commit to a branch where the development release will live (create it if it does not exist)
125
125
- `git checkout -b future-release`
126
+
- `git add slack_cli_hooks/version.py`
126
127
- `git commit -m 'version 1.3.0.dev0'`
127
128
- `git push future-release`
128
-
- Create a git tag for the release. For example `git tag v1.3.0.dev0`.
129
+
- Create a git tag for the release. For example `git tag 1.3.0.dev0`.
129
130
- Push the tag up to github with `git push origin --tags`
130
131
131
132
2. Distribute the release
132
133
- Use the latest stable Python runtime
133
134
- `python -m venv .venv`
134
-
- `./scripts/deploy_to_prod_pypi.sh`
135
+
- `scripts/deploy_to_prod_pypi.sh`
135
136
- You do not need to create a GitHub release
136
137
137
138
3. (Slack Internal) Communicate the release internally
@@ -141,35 +142,26 @@ It is possible to deploy this project on <https://test.pypi.org/> in order to tr
141
142
1. Create the commit for the release:
142
143
- Bump the version number in adherence to [Semantic Versioning](http://semver.org/) in`slack_cli_hooks/version.py`
143
144
- Commit with a message including the new version number. For example `1.2.3`& Push the commit to a branch and create a PR to sanity check.
144
-
- `git checkout -b v1.2.3-release`
145
+
- `git checkout -b 1.2.3-release`
146
+
- `git add slack_cli_hooks/version.py`
145
147
- `git commit -m 'version 1.2.3'`
146
-
- `git push {your-fork} v1.2.3-release`
147
-
- Merge in release PR after getting an approval from at least one maintainer.
148
-
- Create a git tag for the release. For example `git tag v1.2.3`.
149
-
- Push the tag up to github with `git push origin --tags`
148
+
- `git push {your-fork} 1.2.3-release`
149
+
- Create a release PR and get an approval from at least one maintainer.
150
+
- Merge in your release PR.
150
151
151
152
2. Distribute the release
152
153
- Use the latest stable Python runtime
153
154
- `python -m venv .venv`
154
-
- `./scripts/deploy_to_pypi_org.sh`
155
+
- `/scripts/deploy_to_prod_pypi.sh`
155
156
- Create a GitHub release - <https://github.com/slackapi/python-slack-hooks/releases>
156
-
157
-
```markdown
158
-
## New Features
159
-
160
-
### Awesome Feature 1
161
-
162
-
Description here.
163
-
164
-
### Awesome Feature 2
165
-
166
-
Description here.
167
-
168
-
## Changes
169
-
170
-
*#123 Make it better - thanks @SlackHQ
171
-
* #123 Fix something wrong - thanks @seratch
172
-
```
157
+
- Click `Draft a new release`
158
+
- Input the new version you setin [version.py](../slack_cli_hooks/version.py) manually as the `choose a tag` input (example `1.2.3`)
159
+
- After you input the new version, click the "Create a new tag: x.x.x on publish" button.
160
+
- Set the "Target" input to the "main" branch.
161
+
- Name the release title after the version tag.
162
+
- Auto-generate the release notes by clicking the "Auto-generate release notes" button.
163
+
- Make any adjustments to generated release notes to make sure they are accessible and approachable and that an end-user with little context about this project could still understand.
164
+
- Publish the release by clicking the "Publish release" button!
173
165
174
166
3. (Slack Internal) Communicate the release internally
0 commit comments