Skip to content

Commit 35753bd

Browse files
authored
Merge pull request #117 from wiremock/add-release-information
chore: Add release documentation and update docs link in the readme
2 parents c0cc50f + 25d82c4 commit 35753bd

File tree

2 files changed

+30
-1
lines changed

2 files changed

+30
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
---
2121

2222
Python WireMock is a library that allows users to interact with a WireMock instance from within a Python project.
23-
Full documentation can be found at [wiremock.readthedocs.org](http://wiremock.readthedocs.org/).
23+
Full documentation can be found at [wiremock.readthedocs.org](https://wiremock.readthedocs.org/).
2424

2525
[![a](https://img.shields.io/badge/slack-%23wiremock%2Fpython-brightgreen?style=flat&logo=slack)](https://slack.wiremock.org/)
2626
[![Docs](https://img.shields.io/badge/docs-latest-brightgreen.svg)](http://wiremock.readthedocs.org/)

RELEASING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Checklist for releasing WireMock
2+
3+
- [ ] Bump version number
4+
- [ ] Publish the release note
5+
- [ ] Announce on the WireMock Community Slack
6+
- [ ] Announce on social
7+
8+
## Pre-release - bump version number
9+
Make sure the version number has been updated. Do this by updating the version in `./pyproject.toml`:
10+
11+
```toml
12+
[tool.poetry]
13+
name = "wiremock"
14+
version = "2.7.0"
15+
```
16+
17+
Commit and push the changes made.
18+
19+
## Publish the release note
20+
Release drafter should have created a draft release note called "next". Check it for sanity and edit it to add any
21+
additional information and then set the tag to the version you have just added above. You can then publish the release.
22+
23+
Publishing the release should trigger the release action to publish to PyPI
24+
25+
## Post an announcement on the WireMock Community Slack
26+
Announce in the #announcments channel then link to the message from #general.
27+
28+
## Shout about it on as many social media platforms as possible
29+
You know the drill.

0 commit comments

Comments
 (0)