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 57fbd44
Show file tree
Hide file tree
Showing 18 changed files with 2,461 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
76 changes: 76 additions & 0 deletions .github/workflows/cd.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
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:
- uses: actions/checkout@v3

- name: Set up Python
uses: actions/setup-python@v4
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: "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
138 changes: 138 additions & 0 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
name: "CI"

on:
push:
branches: [main]
pull_request:

concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
cancel-in-progress: true

jobs:
commits:
name: "Commits"
if: github.event_name == 'pull_request'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- name: "Check commits of the PR branch"
run: ./.github/check_commits.sh

linters:
name: "Linters"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- name: "Set up Python"
id: setup-python
uses: actions/setup-python@v4
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: "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:
- uses: actions/checkout@v3

- name: "Set up Python"
id: setup-python
uses: actions/setup-python@v4
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: "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:
- uses: actions/checkout@v3

- name: "Set up Python ${{ matrix.python-version }}"
id: setup-python
uses: actions/setup-python@v4
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: "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.7' && matrix.os == 'ubuntu-latest'
uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
with:
files: coverage.xml
164 changes: 164 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,164 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
.pdm.toml
.pdm-python
.pdm-build/

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/

embeddings_cache/
Loading

0 comments on commit 57fbd44

Please sign in to comment.