Skip to content

Latest commit

 

History

History
78 lines (51 loc) · 2.36 KB

release_process.rst

File metadata and controls

78 lines (51 loc) · 2.36 KB

Automated Production Release Process

This repo utilizes python-semantic-release in conjunction with GitHub Actions to create releases automatically.

Manually Creating a Production Release

ONLY UNDER LIMITED CIRCUMSTANCES SHOULD THIS PROCESS BE USED!

Prerequisites

Getting Help with Make Tasks

Execute the following command to get a full list of make targets:

$ make help

Setup Python Development Environment

  1. Create a Python virtual environment:

    $ mkvirtualenv -p py310 pytest-flask-ligand

  2. Setup develop environment:

    $ make develop-venv

  3. Setup git pre-commit hooks:

    $ make setup-pre-commit

  4. Verify that environment is ready for development:

    $ make test-all

Configuring Environment Variables

The following environment variables are necessary for creating a full production release:

Environment Variables
ENV Description
GH_TOKEN

A personal access token from GitHub. This is used for authenticating when pushing tags, publishing releases etc. See Configuring push to Github for usage.

To generate a token go to https://github.com/settings/tokens and click on Personal access token.
REPOSITORY_USERNAME

Used together with REPOSITORY_PASSWORD when publishing artifact.

Note: If you use token authentication with pypi set this to __token__.
REPOSITORY_PASSWORD Used together with REPOSITORY_USERNAME when publishing artifact. Also used for token when using token authentication.

Publish the Release

Simply execute the following make target:

$ make publish