Skip to content

Commit

Permalink
Update release.md (#324)
Browse files Browse the repository at this point in the history
* update release process

* update release notes

* fix spelling
  • Loading branch information
thehomebrewnerd committed May 12, 2022
1 parent 67157bc commit 76e8991
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
1 change: 1 addition & 0 deletions docs/source/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Future Release
* Add in-line tabs and copy-paste functionality to docs (:pr:`293`)
* Update nbconvert to version 6.4.5 to fix docs build issue (:pr:`305`)
* Update slack invite link to new (:pr:`316`)
* Update ``release.md`` with correct process (:pr:`324`)
* Testing Changes
* Add woodwork to ``test-requirements.txt`` (:pr:`296`)
* Upgrade black version to 22.3.0 to fix linting issue (:pr:`309`)
Expand Down
4 changes: 2 additions & 2 deletions release.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Release Process
## Prerequisites
The environment variables `PYPI_USERNAME` and `PYPI_PASSWORD` must be already set in the repository as secrets. To add these variables, go to Secrets in the Settings of the repostiory.
The environment variables `PYPI_USERNAME` and `PYPI_PASSWORD` must be already set in the repository as secrets. To add these variables, go to Secrets in the Settings of the repository.

## Create Release Branch
1. Branch off of main and name the branch the release version number (e.g. v0.1.2)
2. Bump verison number in `setup.py`, and `composeml/__init__.py`.
2. Bump version number in ``composeml/version.py`, and `composeml/tests/test_version.py`.

## Create Release PR
A release PR should have the version number as the title and the changelog updates as the PR body text. The contributors line is not necessary.
Expand Down

0 comments on commit 76e8991

Please sign in to comment.