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

Update RELEASING.md #47

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update RELEASING.md #47

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 27 additions & 1 deletion RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,35 @@
# Releasing Sending

## Prerequisites

1. Verify poetry 1.2 is installed and properly configured.
2. Create an API token scoped to Sending on pypi. Make sure that two factor auth is enabled for pypi.
3. Setup poetry to use your pypi token: `poetry config pypi-token.pypi <your token>`

## Create a Pull Request for Release

Branch protection for `main` is enabled for this repo. You will do the following steps.

1. Update the `CHANGELOG.md`
2. Update `sending/__init__.py` version
3. Update `pyproject.toml` version

Create a pull request from your release branch to `main` by:

```
poetry version $VERSION
git commit -a -m "Releasing version $VERSION"
git tag -a "v$VERSION" -m "Release v$VERSION"
git push origin <release branch name>
```

## Publish to pypi

After the release PR is approved:

```
poetry build
poetry publish
```
```

Verify on pypi that package is there and can be installed.