diff --git a/README.md b/README.md index e495272..c7fae0f 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ --- Python WireMock is a library that allows users to interact with a WireMock instance from within a Python project. -Full documentation can be found at [wiremock.readthedocs.org](http://wiremock.readthedocs.org/). +Full documentation can be found at [wiremock.readthedocs.org](https://wiremock.readthedocs.org/). [![a](https://img.shields.io/badge/slack-%23wiremock%2Fpython-brightgreen?style=flat&logo=slack)](https://slack.wiremock.org/) [![Docs](https://img.shields.io/badge/docs-latest-brightgreen.svg)](http://wiremock.readthedocs.org/) diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 0000000..f10f3cf --- /dev/null +++ b/RELEASING.md @@ -0,0 +1,29 @@ +# Checklist for releasing WireMock + +- [ ] Bump version number +- [ ] Publish the release note +- [ ] Announce on the WireMock Community Slack +- [ ] Announce on social + +## Pre-release - bump version number +Make sure the version number has been updated. Do this by updating the version in `./pyproject.toml`: + +```toml +[tool.poetry] +name = "wiremock" +version = "2.7.0" +``` + +Commit and push the changes made. + +## Publish the release note +Release drafter should have created a draft release note called "next". Check it for sanity and edit it to add any +additional information and then set the tag to the version you have just added above. You can then publish the release. + +Publishing the release should trigger the release action to publish to PyPI + +## Post an announcement on the WireMock Community Slack +Announce in the #announcments channel then link to the message from #general. + +## Shout about it on as many social media platforms as possible +You know the drill. \ No newline at end of file