Skip to content

Latest commit

 

History

History
234 lines (143 loc) · 6.36 KB

RELEASE.md

File metadata and controls

234 lines (143 loc) · 6.36 KB
Raw

Release workflow

The process of releasing a new version involves several steps:

  1. Install RDT from source

  2. Linting and tests

  3. Documentation

  4. Milestone

  5. HISTORY.md

  6. Distribution

  7. Integration with SDV

7.1. Install SDV from source

7.2. Install from distribution

7.3. Run SDV tests and README.md examples

  1. Making the release

8.1. Tag and release to PyPi

8.2. Update the release on GitHub

Install RDT from source

Clone the project and install the development requirements before start the release process. Alternatively, with your virtualenv activated.

git clone https://github.com/sdv-dev/RDT
cd RDT
git checkout main
make install-develop

Linting and tests

Execute ALL the tests and linting, tests must end with no errors:

make test-all

This command will use tox to execute the unittests with different environments, see tox.ini configuration.

To be able to run this you will need the different python versions used in the tox.ini file.

At the end, you will see an output like this:

_____________________________________________ summary ______________________________________________
  py35: commands succeeded
  py36: commands succeeded
  lint: commands succeeded
  docs: commands succeeded

To run the tests over your python version:

make test && make lint

And you will see something like this:

================================== 41 passed, 5 skipped in 1.29s ===================================
invoke lint
No broken requirements found.
All checks passed!
73 files already formatted

The execution has finished with no errors and 5 tests skipped.

Documentation

The documentation must be up to date and generated with:

make view-docs

Read the documentation to ensure all the changes are reflected in the documentation.

Alternatively, you can simply generate the documentation using the command:

make docs

Milestone

It's important check that the git hub and milestone issues are up to date with the release.

You need to check that:

  • The milestone for the current release exists.

  • All the issues closed since the latest release are associated to the milestone. If they are not, associate them.

  • All the issues associated to the milestone are closed. If there are open issues but the milestone needs to be released anyway, move them to the next milestone.

  • All the issues in the milestone are assigned to at least one person.

  • All the pull requests closed since the latest release are associated to an issue. If necessary, create issues and assign them to the milestone. Also assigne the person who opened the issue to them.

HISTORY.md

Make sure HISTORY.md is updated with the issues of the milestone:

# History

## X.Y.Z (YYYY-MM-DD)

### New Features

* <ISSUE TITLE> - [Issue #<issue>](https://github.com/sdv-dev/RDT/issues/<issue>) by @resolver

### General Improvements

* <ISSUE TITLE> - [Issue #<issue>](https://github.com/sdv-dev/RDT/issues/<issue>) by @resolver

### Bug Fixed

* <ISSUE TITLE> - [Issue #<issue>](https://github.com/sdv-dev/RDT/issues/<issue>) by @resolver

The issue list per milestone can be found here.

Distribution

Generate the distribution executing:

make dist

This will create a dist and build directories. The dist directory contains the library installer.

dist/
├── rdt-<version>-py2.py3-none-any.whl
└── rdt-<version>.tar.gz

Now, create a new virtualenv with the distributed file generated and run the README.md examples:

  1. Create the rdt-test directory (out of the RDT directory):
mkdir rdt-test
cd rdt-test
  1. Create a new virtuelenv and activate it:
virtualenv -p $(which python3.6) .venv
source .venv/bin/activate
  1. Install the wheel distribution:
pip install /path/to/rdt/dist/<rdt-distribution-version-any>.whl
  1. Now you are ready to execute the README.md examples.

Integration with SDV

Install SDV from source

Clone the project and install the development requirements. Alternatively, with your virtualenv activated.

git clone https://github.com/sdv-dev/SDV
cd SDV
git checkout main
make install-develop

Install from distribution

Install the RDT version from the generated distribution file.

pip install /path/to/rdt/dist/<rdt-distribution-version-any>.whl

Run SDV tests and README.md examples

Execute the SDV tests to ensure that the new distribution version works.

make test

Also, execute the SDV README.md examples.

Making the release

At the end, we need to make the release. First, check if the release can be made:

make check-release

Tag and release to PyPi

Once we are sure that the release can be made we can use different commands depending on the type of release that we want to make:

  • make release: This will relase a patch, which is the most common type of release. Use this when the changes are bugfixes or enhancements that do not modify the existing user API. Changes that modify the user API to add new features but that do not modify the usage of the previous features can also be released as a patch.

  • make release-minor: This will release the next minor version. Use this if the changes modify the existing user API in any way, even if it is backwards compatible. Minor backwards incompatible changes can also be released as minor versions while the library is still in beta state. After the major version 1 has been released, minor version can only be used to add backwards compatible API changes.

  • make release-major: This will release the next major version. Use this to if the changes modify the user API in a backwards incompatible way after the major version 1 has been released.

Update the release on GitHub

Once the tag and the release to PyPi has been made, go to GitHub and edit the freshly created "tag" to add the title and release notes, which should be exactly the same that we added to the HISTORY.md file.

Finaly, close the milestone and, if it does not exit, create the next one.