Skip to content

Commit

Permalink
update release checklist
Browse files Browse the repository at this point in the history
  • Loading branch information
robamu committed Sep 4, 2023
1 parent 291724f commit 3d39808
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 37 deletions.
37 changes: 0 additions & 37 deletions lint.py

This file was deleted.

9 changes: 9 additions & 0 deletions release_checklist.md → release-checklist.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Checklist for new releases
========

The steps shown here are for Ubuntu/MacOS.

# Pre-Release

1. Make sure the docs build with Sphinx, using `make html` inside the
Expand All @@ -14,6 +16,13 @@ Checklist for new releases
6. Run linter script `flake8 .`
7. Wait for CI/CD results. This also runs the tests on different operating systems

# Release

1. Deleting existing distribution: `rm dist/*`
2. Build the package. Requires the `build` package: `python3 -m build`
3. Upload the source and build distribution: `python3 -m twine upload dist/*`. You might require
a PyPI upload token to do this.

# Post-Release

1. Create new release on `GitHub` based on the release branch. This also creates
Expand Down

0 comments on commit 3d39808

Please sign in to comment.