Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update release.md with correct instructions #140

Merged
merged 4 commits into from
Oct 22, 2019
Merged

Update release.md with correct instructions #140

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d42c2fb
Update release.md with correct instructions
jeremyliweishih Oct 17, 2019
b0400f4
Formatting
jeremyliweishih Oct 17, 2019
602c619
Syntax changes
jeremyliweishih Oct 22, 2019
c19006b
Changed text style for code
jeremyliweishih Oct 22, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 18 additions & 12 deletions release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,26 @@
# 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 repository.

## Create Release Branch
1. Branch off of master and name the branch the release version number (e.g. v0.1.2)
2. Bump verison number in `setup.py`, and `evalml/__init__.py`.
## Run Integration Tests
Before creating a release EvalML integration tests should be run. Instructions can be found here:
https://github.com/FeatureLabs/evalml-integration-tests

## 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.
A release PR should have the version number as the title and the changelog updates as the PR body text.
The PR should include the following:
* Changes to `setup.py` and `evalml/__init__.py` to bump `__version__` to the correct version
jeremyliweishih marked this conversation as resolved.
Show resolved Hide resolved
* Move change log items from `Future Releases` into the correct version number
jeremyliweishih marked this conversation as resolved.
Show resolved Hide resolved
* Confirm that all release items are in the changelog

## Create GitHub Release
After the release pull request has been merged into the master branch, it is time draft the github release.
* The target should be the master branch
* The tag should be the version number with a v prefix (e.g. v0.1.2)
* Release title is the same as the tag
* Release description should be the full changelog updates for the release, including the line thanking contributors.
* The target should be the master branch
* The tag should be the version number with a v prefix (e.g. v0.1.2)
* Release title is the same as the tag
* Release description should be the full changelog updates for the release.

## Release on PyPI
After publishing the release on GitHub, a GitHub Action will automatically upload the package to PyPI.
## Release using Release-tools
Run the following assuming you have release-tools installed:
* flrelease build-package
* flrelease upload-package <--url or --license> <install.featurelabs.com or licenses/user.json>

More details can be found here: https://github.com/FeatureLabs/release-tools