Skip to content

Commit

Permalink
Add initial implementation
Browse files Browse the repository at this point in the history
  • Loading branch information
blomqma committed Oct 27, 2024
1 parent c37b1e3 commit ab4d6b6
Show file tree
Hide file tree
Showing 18 changed files with 2,502 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
root = true

[*.py]
indent_style = space
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
4 changes: 4 additions & 0 deletions .flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[flake8]
max-line-length = 88
ignore = E203, W503
exclude = .git,__pycache__,env,.venv,venv
82 changes: 82 additions & 0 deletions .github/workflows/cd.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
name: "CD"

on:
workflow_dispatch:
inputs:
release-type:
description: "Type of release?"
required: true
type: choice
options:
- patch
- minor
- major

jobs:
release:
name: "Release"
if: github.event.inputs.branch == 'main'
runs-on: ubuntu-latest
steps:
- name: "Checkout code"
uses: actions/checkout@v2
with:
token: ${{ secrets.GH_PAT }}

- name: "Set up Python"
uses: actions/setup-python@v2
with:
python-version: "3.7"

- name: "Install Poetry"
uses: snok/install-poetry@5e4414407e59f94f2148bcb253917dfc22dee7d9 # v1.3.0
with:
virtualenvs-create: true
virtualenvs-in-project: true

- name: "Add Poetry to PATH"
run: echo "$HOME/.local/bin" >> $GITHUB_PATH

- name: "Bump pyproject.toml version"
id: bump
run: |
poetry version ${{ github.event.inputs.release-type }}
echo "::set-output name=version::$(poetry version --short)"
- name: "Bump `git_vector.__version__`"
run: sed -i 's/^__version__ *=.*/__version__ = "${{ steps.bump.outputs.version }}"/' git_vector/__init__.py

- name: "Update the changelog"
# Find the first line that starts with `###` or `## [<number>` from the CHANGELOG and insert the new version header before it.
run: sed -i "0,/^\(###\|## *\[[0-9]\).*/{s//## [${{ steps.bump.outputs.version }}] - $(date -u '+%Y-%m-%d')\n\n&/}" CHANGELOG.md

- name: "Extract version's changelog for release notes"
# 1. Find the lines between the first `## [<number>` and the second `## [<number>`.
# 2. Remove all leading and trailing newlines from the output.
run: sed '1,/^## *\[[0-9]/d;/^## *\[[0-9]/Q' CHANGELOG.md | sed -e :a -e '/./,$!d;/^\n*$/{$d;N;};/\n$/ba' > release_notes.txt

- name: "Commit and tag the changes"
run: |
git config user.name 'github-actions'
git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
git add pyproject.toml git_vector/__init__.py CHANGELOG.md
git commit --message='Release ${{ steps.bump.outputs.version }}'
git tag --annotate --message='' v${{ steps.bump.outputs.version }}
- name: "Build the wheel"
run: poetry build

- name: "Publish to PyPI"
run: poetry publish
env:
POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_TOKEN }}

- name: "Push the changes"
run: git push --follow-tags

- name: "Create a GitHub release"
uses: softprops/action-gh-release@1e07f4398721186383de40550babbdf2b84acfc5 # v1
with:
tag_name: v${{ steps.bump.outputs.version }}
name: v${{ steps.bump.outputs.version }}
body_path: release_notes.txt
137 changes: 137 additions & 0 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
name: CI

on:
push:
branches: [main]
pull_request:
branches: [main]

jobs:
linters:
name: "Linters"
runs-on: ubuntu-latest
steps:
- name: "Checkout code"
uses: actions/checkout@v2

- name: "Set up Python"
id: setup-python
uses: actions/setup-python@v2
with:
python-version: "3.7"

- name: "Install Poetry"
uses: snok/install-poetry@5e4414407e59f94f2148bcb253917dfc22dee7d9 # v1.3.0
with:
virtualenvs-create: true
virtualenvs-in-project: true

- name: "Add Poetry to PATH"
run: echo "$HOME/.local/bin" >> $GITHUB_PATH

- name: "Load cached venv"
id: cached-poetry-dependencies
uses: actions/cache@v2
with:
path: .venv
key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}

- name: "Install dependencies"
if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
run: poetry install --no-root

- name: "Run linters"
run: |
source "$VENV"
isort --check-only --diff .
flake8 .
black --check --diff .
build:
name: "Build"
runs-on: ubuntu-latest
steps:
- name: "Checkout code"
uses: actions/checkout@v2

- name: "Set up Python"
id: setup-python
uses: actions/setup-python@v2
with:
python-version: "3.7"

- name: "Install Poetry"
uses: snok/install-poetry@5e4414407e59f94f2148bcb253917dfc22dee7d9 # v1.3.0
with:
virtualenvs-create: true
virtualenvs-in-project: true

- name: "Add Poetry to PATH"
run: echo "$HOME/.local/bin" >> $GITHUB_PATH

- name: "Build the wheel"
run: poetry build

- name: "Install from the wheel"
run: pip install dist/*.whl

tests:
name: "Tests"
needs: [linters, build]
strategy:
fail-fast: true
matrix:
python-version: ["3.7", "3.8", "3.9", "3.10"]
os: [ubuntu-latest, macos-latest, windows-latest]
defaults:
run:
shell: bash
runs-on: ${{ matrix.os }}
steps:
- name: "Checkout code"
uses: actions/checkout@v2

- name: "Set up Python ${{ matrix.python-version }}"
id: setup-python
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}

- name: "Install Poetry"
uses: snok/install-poetry@5e4414407e59f94f2148bcb253917dfc22dee7d9 # v1.3.0
with:
virtualenvs-create: true
virtualenvs-in-project: true

- name: "Add Poetry to PATH"
run: echo "$HOME/.local/bin" >> $GITHUB_PATH

- name: "Load cached venv"
id: cached-poetry-dependencies
uses: actions/cache@v2
with:
path: .venv
key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}

- name: "Install dependencies"
if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
run: poetry install --no-root

- name: "Install the package"
run: poetry install

- name: "Run type-checking"
run: |
source "$VENV"
mypy .
- name: "Run tests"
run: |
source "$VENV"
pytest --verbose --cov=. --cov-report=xml .
- name: "Upload coverage"
if: matrix.python-version == '3.10' && matrix.os == 'ubuntu-latest'
uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
with:
files: coverage.xml
Loading

0 comments on commit ab4d6b6

Please sign in to comment.