This repository has been archived by the owner on Sep 11, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
431 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
name: 'Set up Poetry and install' | ||
description: 'Set up a specific version of Poetry and install dependencies using caching.' | ||
inputs: | ||
python-version: | ||
description: "Version range or exact version of Python or PyPy to use, using SemVer's version range syntax." | ||
default: '3.11' | ||
runs: | ||
using: 'composite' | ||
steps: | ||
- name: Install poetry | ||
run: pipx install poetry==1.8.3 | ||
shell: bash | ||
- uses: actions/setup-python@v4 | ||
with: | ||
python-version: ${{ inputs.python-version }} | ||
cache: 'poetry' | ||
- name: Install dependencies | ||
run: poetry install | ||
shell: bash |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
#!/bin/bash | ||
|
||
set -e # trigger failure on error - do not remove! | ||
set -x # display command on output | ||
|
||
if [ -z "${TARGET_VERSION}" ]; then | ||
>&2 echo "No TARGET_VERSION specified" | ||
exit 1 | ||
fi | ||
CHGLOG_FILE="${CHGLOG_FILE:-CHANGELOG.md}" | ||
|
||
# update package version | ||
poetry version "${TARGET_VERSION}" | ||
|
||
# collect release notes | ||
REL_NOTES=$(mktemp) | ||
poetry run semantic-release changelog --unreleased >> "${REL_NOTES}" | ||
|
||
# update changelog | ||
TMP_CHGLOG=$(mktemp) | ||
TARGET_TAG_NAME="v${TARGET_VERSION}" | ||
RELEASE_URL="$(gh repo view --json url -q ".url")/releases/tag/${TARGET_TAG_NAME}" | ||
printf "## [${TARGET_TAG_NAME}](${RELEASE_URL}) - $(date -Idate)\n\n" >> "${TMP_CHGLOG}" | ||
cat "${REL_NOTES}" >> "${TMP_CHGLOG}" | ||
if [ -f "${CHGLOG_FILE}" ]; then | ||
printf "\n" | cat - "${CHGLOG_FILE}" >> "${TMP_CHGLOG}" | ||
fi | ||
mv "${TMP_CHGLOG}" "${CHGLOG_FILE}" | ||
|
||
# push changes | ||
git config --global user.name 'github-actions[bot]' | ||
git config --global user.email 'github-actions[bot]@users.noreply.github.com' | ||
git add pyproject.toml "${CHGLOG_FILE}" | ||
COMMIT_MSG="chore: bump version to ${TARGET_VERSION} [skip ci]" | ||
git commit -m "${COMMIT_MSG}" | ||
git push origin main | ||
|
||
# create GitHub release (incl. Git tag) | ||
gh release create "${TARGET_TAG_NAME}" -F "${REL_NOTES}" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
name: "Run CD" | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
|
||
env: | ||
# disable keyring (https://github.com/actions/runner-images/issues/6185): | ||
PYTHON_KEYRING_BACKEND: keyring.backends.null.Keyring | ||
|
||
jobs: | ||
# To be enabled when we add docs | ||
# docs: | ||
# permissions: | ||
# contents: write | ||
# runs-on: ubuntu-latest | ||
# steps: | ||
# - uses: actions/checkout@v3 | ||
# - uses: ./.github/actions/setup-poetry | ||
# - name: Build and push docs | ||
# run: poetry run mkdocs gh-deploy --force | ||
|
||
code-checks: | ||
uses: ./.github/workflows/checks.yml | ||
pre-release-check: | ||
runs-on: ubuntu-latest | ||
outputs: | ||
TARGET_TAG_V: ${{ steps.version_check.outputs.TRGT_VERSION }} | ||
steps: | ||
- uses: actions/checkout@v3 | ||
with: | ||
fetch-depth: 0 # for fetching tags, required for semantic-release | ||
- uses: ./.github/actions/setup-poetry | ||
- name: Check version of potential release | ||
id: version_check | ||
run: | | ||
TRGT_VERSION=$(poetry run semantic-release print-version) | ||
echo "TRGT_VERSION=${TRGT_VERSION}" >> $GITHUB_OUTPUT | ||
echo "${TRGT_VERSION}" | ||
- name: Check notes of potential release | ||
run: poetry run semantic-release changelog --unreleased | ||
release: | ||
needs: [code-checks, pre-release-check] | ||
if: needs.pre-release-check.outputs.TARGET_TAG_V != '' | ||
environment: auto-release | ||
runs-on: ubuntu-latest | ||
concurrency: release | ||
steps: | ||
- uses: actions/checkout@v3 | ||
with: | ||
token: ${{ secrets.GH_PAT }} | ||
fetch-depth: 0 # for fetching tags, required for semantic-release | ||
- uses: ./.github/actions/setup-poetry | ||
- name: Run release script | ||
env: | ||
GH_TOKEN: ${{ secrets.GH_PAT }} | ||
TARGET_VERSION: ${{ needs.pre-release-check.outputs.TARGET_TAG_V }} | ||
CHGLOG_FILE: CHANGELOG.md | ||
run: ./.github/scripts/release.sh | ||
shell: bash |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
on: | ||
workflow_call: | ||
|
||
jobs: | ||
run-checks: | ||
runs-on: ubuntu-latest | ||
strategy: | ||
matrix: | ||
python-version: ['3.9', '3.10', '3.11', '3.12'] | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- uses: ./.github/actions/setup-poetry | ||
with: | ||
python-version: ${{ matrix.python-version }} | ||
- name: Run styling check | ||
run: poetry run pre-commit run --all-files |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
name: "Run CI" | ||
|
||
on: | ||
pull_request: | ||
types: [opened, reopened, synchronize, ready_for_review] | ||
push: | ||
branches: | ||
- "**" | ||
- "!main" | ||
- "!gh-pages" | ||
|
||
env: | ||
# disable keyring (https://github.com/actions/runner-images/issues/6185): | ||
PYTHON_KEYRING_BACKEND: keyring.backends.null.Keyring | ||
|
||
jobs: | ||
code-checks: | ||
uses: ./.github/workflows/checks.yml | ||
|
||
# To enable when we add the ./docs | ||
# build-docs: | ||
# runs-on: ubuntu-latest | ||
# steps: | ||
# - uses: actions/checkout@v3 | ||
# - uses: ./.github/actions/setup-poetry | ||
# - name: Build docs | ||
# run: poetry run mkdocs build --verbose --clean | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
name: "Build and publish package" | ||
|
||
on: | ||
release: | ||
types: [published] | ||
|
||
permissions: | ||
contents: read | ||
|
||
env: | ||
# disable keyring (https://github.com/actions/runner-images/issues/6185): | ||
PYTHON_KEYRING_BACKEND: keyring.backends.null.Keyring | ||
|
||
jobs: | ||
build-and-publish: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- uses: ./.github/actions/setup-poetry | ||
- name: Build and publish | ||
run: poetry publish --build --no-interaction --username=__token__ --password=${{ secrets.PYPI_TOKEN }} |
Oops, something went wrong.