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.

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

Add automated release process #43

Merged
merged 4 commits into from
Jun 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
81 changes: 81 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
name: Release To PyPI

on:
workflow_dispatch:
inputs:
requested_release_tag:
description: 'The tag to use for this release (e.g., `v2.3.0`)'
required: true

jobs:
build_and_upload:
runs-on: arc-amd64-runners
environment: production
steps:
- uses: actions/checkout@v2

- uses: actions/setup-python@v2
name: Install Python
with:
python-version: 3.8

- run: |
pip install packaging
- name: Normalize the release version
run: |
echo "release_version=`echo '${{ github.event.inputs.requested_release_tag }}' | sed 's/^v//'`" >> $GITHUB_ENV
- name: Normalize the release tag
run: |
echo "release_tag=v${release_version}" >> $GITHUB_ENV
- name: Get the VERSION from setup.py
run: |
echo "package_version=`grep -Po '__version__ = "\K[^"]*' quotequail/__init__.py`" >> $GITHUB_ENV
- name: Get the latest version from PyPI
run: |
curl https://pypi.org/pypi/quotequail/json | python -c 'import json, sys; contents=sys.stdin.read(); parsed = json.loads(contents); print("pypi_version=" + parsed["info"]["version"])' >> $GITHUB_ENV
- name: Log all the things
run: |
echo 'Requested release tag `${{ github.event.inputs.requested_release_tag }}`'
echo 'Release version `${{ env.release_version }}`'
echo 'Release tag `${{ env.release_tag }}`'
echo 'version in package `${{ env.package_version }}`'
echo 'Version in PyPI `${{ env.pypi_version }}`'
- name: Verify that the version string we produced looks like a version string
run: |
echo "${{ env.release_version }}" | sed '/^[0-9]\+\.[0-9]\+\.[0-9]\+$/!{q1}'
- name: Verify that the version tag we produced looks like a version tag
run: |
echo "${{ env.release_tag }}" | sed '/^v[0-9]\+\.[0-9]\+\.[0-9]\+$/!{q1}'
- name: Verify that the release version matches the VERSION in the package source
run: |
[[ ${{ env.release_version }} == ${{ env.package_version }} ]]
- name: Verify that the `release_version` is larger/newer than the existing release in PyPI
run: |
python -c 'import sys; from packaging import version; code = 0 if version.parse("${{ env.package_version }}") > version.parse("${{ env.pypi_version }}") else 1; sys.exit(code)'
- name: Verify that the `release_version` is present in the CHANGELOG
run: |
grep ${{ env.release_version }} CHANGELOG.md
- name: Serialize normalized release values as outputs
run: |
echo "release_version=$release_version"
echo "release_tag=$release_tag"
echo "release_version=$release_version" >> $GITHUB_OUTPUT
echo "release_tag=$release_tag" >> $GITHUB_OUTPUT
- name: Tag commit
uses: actions/github-script@v7.0.1
with:
script: |
github.rest.git.createRef({
owner: context.repo.owner,
repo: context.repo.repo,
ref: 'refs/tags/${{ env.release_tag }}',
sha: context.sha
})
- name: Build Source Distribution
run: |
python setup.py sdist
- name: Upload to PyPI
uses: closeio/gh-action-pypi-publish@a260c7e54e4251db69485e1e7ca271aec8c0ddf9
with:
user: __token__
password: ${{ secrets.PYPI_TOKEN }}
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Changes

## v0.2.4

* First version using auto-release process
* Added support for russian, portuguese, and swedish reply patterns
* Fixed bug where newlines just before "wrote:" weren't detected
* updated repo to apply more modern linting + code style

1 change: 1 addition & 0 deletions quotequail/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

from . import _internal, _patterns

__version__ = "0.2.4"
__all__ = ["quote", "quote_html", "unwrap", "unwrap_html"]


Expand Down
8 changes: 7 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
import re

from setuptools import setup

VERSION_FILE = "quotequail/__init__.py"
with open(VERSION_FILE, encoding="utf8") as fd:
version = re.search(r'__version__ = ([\'"])(.*?)\1', fd.read()).group(2)

setup(
name="quotequail",
version="0.2.3",
version=version,
url="http://github.com/closeio/quotequail",
license="MIT",
author="Thomas Steinacher",
Expand Down
Loading