Skip to content

Commit

Permalink
Release 0.0.1rc3 (#12)
Browse files Browse the repository at this point in the history
* Tweak contributing guidelines

* Use GitHub releases
  • Loading branch information
bhrutledge committed Oct 23, 2019
1 parent 7092a3e commit 680d82f
Showing 1 changed file with 22 additions and 30 deletions.
52 changes: 22 additions & 30 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ During development, use the provided tools to check for consistent style, codin

## Setting up a development environment

- [Fork and clone](https://help.github.com/en/articles/fork-a-repo) this repository.
- [Fork and clone](https://help.github.com/en/articles/fork-a-repo) this repository

- Create and activate a [virtual environment](https://docs.python.org/3/tutorial/venv.html):
- Create and activate a [virtual environment](https://docs.python.org/3/tutorial/venv.html)

```
$ cd pytest-quarantine
Expand All @@ -26,7 +26,7 @@ During development, use the provided tools to check for consistent style, codin
$ source venv/bin/activate
```
- Install this package and its dependencies for development:
- Install this package and its dependencies for development
```
$ pip install -e .[dev]
Expand All @@ -45,35 +45,35 @@ During development, use the provided tools to check for consistent style, codin
## During development
- Activate your virtual environment:
- Activate your virtual environment
```
$ source venv/bin/activate
```
- Run the tests:
- Run the tests
```
$ pytest
```
- Run the tests and generate a coverage report:
- Run the tests and generate a coverage report
```
$ tox -e py,coverage
```
Please add or update tests to ensure the coverage doesn’t drop.
- Run the formatters and linters:
- Run the formatters and linters
```
$ tox -e check
```
These checks are also run on every commit via [pre-commit hooks](./.pre-commit-config.yaml). Please fix any failures before committing.
- Run the tests in all supported Python versions, generate a coverage report, and run the checks:
- Run the tests in all supported Python versions, generate a coverage report, and run the checks
```
$ tox
Expand All @@ -89,61 +89,53 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
```
$ git checkout master
$ git pull upstream
$ git pull upstream master
```
- Pick a version number (e.g. `1.0.1`) and create a new branch:
- Pick a version number (e.g. `1.0.1`) and create a new branch
```
$ version=1.0.1 branch=release-$version
$ version=1.0.1
$ branch=release-$version
$ git checkout -b $branch
```
- Run the release pipeline and fix any failures (except the version):
- Run the release pipeline and fix any failures (except the version)
```
$ tox -e release
```
- Update the [changelog](./CHANGELOG.md)
- Push the branch, open a PR, and wait for CI to pass
- Push the branch and open a [pull request](https://github.com/bhrutledge/pytest-quarantine/pulls)
```
$ git push -u origin HEAD
```
- Checkout `master` and merge the branch
- Wait for the checks to pass, then squash & merge the pull request
```
$ git checkout master
$ git merge --squash $branch
$ git commit
```
- Create a new [release](https://github.com/bhrutledge/pytest-quarantine/releases) using the version number as the title, and the changelog as the description
- Tag the release, and verify the signature:
- Checkout and update `master`
```
$ git tag -s -m "Preparing release $version" $version
$ git tag -v $version
$ git checkout master
$ git pull upstream master
```
- Push `master` and the new tag:
```
$ git push upstream
$ git push upstream $version
```
- Run the release pipeline to upload to [TestPyPI](https://test.pypi.org/project/pytest-quarantine/)
- Review the release on [GitHub](https://github.com/bhrutledge/pytest-quarantine/releases)
- Run the release pipeline to upload to [TestPyPI](https://test.pypi.org/project/pytest-quarantine/):
- Run the release pipeline to upload to [TestPyPI](https://test.pypi.org/project/pytest-quarantine/)
```
$ tox -e release
```
- If it looks good on TestPyPI, run the release pipeline to upload to [PyPI](https://pypi.org/project/pytest-quarantine/):
- If it looks good on TestPyPI, run the release pipeline to upload to [PyPI](https://pypi.org/project/pytest-quarantine/)
```
$ tox -e release pypi
Expand Down

0 comments on commit 680d82f

Please sign in to comment.