-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
ssallam
committed
May 19, 2020
1 parent
fe6a1a1
commit b9d5a05
Showing
1 changed file
with
36 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# The aquarius Release Process | ||
|
||
- Create a new local feature branch, e.g. `git checkout -b feature/bumpversion-to-v0.2.5` | ||
- Use the `bumpversion.sh` script to bump the project version. You can execute the script using {major|minor|patch} as first argument to bump the version accordingly: | ||
- To bump the patch version: `./bumpversion.sh patch` | ||
- To bump the minor version: `./bumpversion.sh minor` | ||
- To bump the major version: `./bumpversion.sh major` | ||
- Commit the changes to the feature branch. | ||
- Push the feature branch to GitHub. | ||
- Make a pull request from the just-pushed branch. | ||
- Wait for all the tests to pass! | ||
- Merge the pull request into the `develop` branch. | ||
- To make a GitHub release (which creates a Git tag): | ||
- Go to the aquarius repo's Releases page [https://github.com/oceanprotocol/aquarius/releases](https://github.com/oceanprotocol/aquarius/releases) | ||
- Click "Draft a new release". | ||
- For tag version, put something like `v0.2.5` | ||
- For release title, put the same value (like `v0.2.5`). | ||
- For the target, select the `develop` branch, or the just-merged commit. | ||
- Describe the main changes. (In the future, these will come from the changelog.) | ||
- Click "Publish release". | ||
- Travis will detect the release (a new tag) and run the deployment section of [.travis.yml](.travis.yml), i.e. | ||
|
||
```yaml | ||
deploy: | ||
provider: pypi | ||
distributions: sdist bdist_wheel | ||
user: ${PYPI_USER} | ||
password: ${PYPI_PASSWORD} | ||
on: | ||
tags: true | ||
repo: oceanprotocol/aquarius | ||
python: 3.6 | ||
``` | ||
- Go to Travis and check the Travis job. It should deploy a new release to PyPI. | ||
- Check PyPI for the new release at [https://pypi.org/project/ocean-aquarius/](https://pypi.org/project/ocean-aquarius/) |