Skip to content
This repository has been archived by the owner on Sep 26, 2024. It is now read-only.

Commit

Permalink
Update 'Releasing' section in README.md and CONTRIBUTING.md (#9)
Browse files Browse the repository at this point in the history
* Add changelog entry for version upgrade of twister

* Update 'Releasing' section in README.md and CONTRIBUTING.md
  • Loading branch information
dogan-sky authored Aug 19, 2019
1 parent 90c9823 commit 4d70c03
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 6 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# 1.2.0

* [dependencies] Bump twisted from 19.2.1 to 19.7.0 (#8)
* Update releasing instructions in `README.md` and `CONTRIBUTING.md`

# 1.1.0

* [security] Rebuild image using latest upstream python:3.7-alpine tag to fix CVE-2019-5021 (#7)
Expand Down
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,10 @@ the full set of tests run by our build system.

## Releasing

Once a pull request has been merged, the commit in master should be tagged with a new version number and pushed.
Only maintainers are able to do this.
As a project maintainer you will need to release this project to push a new Docker image to Docker Hub, e.g. once a pull request has been merged.

Create a release in GitHub, with the contents of the Changelog for that release version. This will create a tag, for
which Travis will build and publish an image.

This project follows the [Semantic Versioning](https://semver.org/) specification, and version numbers
should be chosen accordingly.
Expand Down
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,4 @@ Please see our [Contributing guidelines](/CONTRIBUTING.md) for more information.

## Releasing

As a project maintainer, you will need to release this project to push a new Docker image to Docker Hub.

Create a release in GitHub, with the contents of the Changelog for that release version. This will create a tag, for
which Travis will build and publish an image.
See instructions in eponymous section in `CONTRIBUTING.md`

0 comments on commit 4d70c03

Please sign in to comment.