Merge pull request #30 from lucas-labs/29-ci

ci: 🔄 push-pr ci config

.github/actions/check-version/Dockerfile

@@ -0,0 +1,7 @@
+FROM python:3-slim
+RUN pip install --upgrade pip
+RUN pip install requests tomli packaging
+
+COPY version_checker.py /version_checker.py
+
+ENTRYPOINT ["python3", "/version_checker.py"]

.github/actions/check-version/action.yml

@@ -0,0 +1,29 @@
+# action.yaml
+name: "poetry project configuration"
+description: "get information about poetry project: version, name, description, etc."
+branding:
+  icon: 'aperture'
+  color: 'green'
+inputs:
+  pyproject-path:
+    description: "location of pyproject file"
+    required: true
+    default: "./pyproject.toml"
+outputs:
+  is-local-higher:
+    description: "True if local version is higher than public version"
+  local-version:
+    description: "Local version of the package"
+  published-version:
+    description: "Public version of the package"
+  package-name:
+    description: "Name of the package"
+  package-description:
+    description: "Description of the package"
+
+runs:
+  using: 'docker'
+  image: 'Dockerfile'
+  args:
+    - ${{ inputs.pyproject-path }}
+    - ${{ inputs.test-regex }}

.github/actions/check-version/version_checker.py

@@ -0,0 +1,37 @@
+import os
+import sys
+
+import tomli
+from packaging import version
+
+# def get_public_version(project_name: str, is_test = False) -> Version:
+#     response = requests.get(
+#         f'https://{"test." if is_test else ""}pypi.org/pypi/{project_name}/json'
+#     )
+#     response.raise_for_status()
+#     return version.parse(json.loads(response.content)['info']['version'])
+
+
+if __name__ == '__main__':
+    pyproject_toml_path = sys.argv[1]
+
+    with open(pyproject_toml_path, 'rb') as f:
+        project = tomli.load(f)
+
+    print(project)
+
+    # project_version = version.parse(project['tool']['poetry']['version'])
+    name = project.get('tool', {}).get('poetry', {}).get('name', None)
+    project_version = version.parse(project.get('tool', {}).get('poetry', {}).get('version', None))
+    description = project.get('tool', {}).get('poetry', {}).get('description', None)
+    is_test = False
+    # public_project_version = get_public_version(project['project']['name'], is_test)
+
+    with open(os.environ['GITHUB_OUTPUT'], 'at') as f:
+        # f.write(
+        #     f'local_version_is_higher={str(project_version > public_project_version).lower()}\n'
+        # )
+        # f.write(f'public_version={str(public_project_version)}\n')
+        f.write(f'local-version={str(project_version)}\n')
+        f.write(f'package-name={name}\n')
+        f.write(f'package-description={description}\n')

.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: "🔄 ci & publish"
+
+on:
+  push:
+    branches:
+      - master
+    paths-ignore:
+      - '**.md'
+      - .editorconfig
+      - .gitignore
+  pull_request:
+    branches:
+      - "*"
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  tests:
+    if: 
+      github.event_name == 'pull_request' || 
+      startsWith(github.event.head_commit.message, 'release:') || 
+      startsWith(github.event.head_commit.message, 'release(')
+    uses: ./.github/workflows/test.yml
+
+
+  draft_release:
+    if: 
+      github.event_name == 'push' &&
+      (
+        startsWith(github.event.head_commit.message, 'release:') || 
+        startsWith(github.event.head_commit.message, 'release(')
+      )
+    needs: [tests]
+    uses: ./.github/workflows/release.yml
+    secrets: inherit
+

.github/workflows/composites/setup/action.yml

@@ -0,0 +1,52 @@
+name: "🏞️ » setup environment"
+description: "setup all necessary tools for the workflow to run"
+inputs:
+  python-version:  
+    description: "Version of python to install"
+    required: true
+
+defaults:
+  run:
+    shell: 'bash'
+
+runs:
+  using: "composite"
+
+  steps:
+    - name: 🏞️ » setup environment
+      shell: bash
+      run: echo "🏞️ » setup environment with python ${{inputs.python-version}}"
+
+    - name: 🐍 » setup python@3
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{inputs.python-version}}
+        cache: "pip"
+
+    - name: 📘 » install Poetry
+      shell: bash
+      run: |
+        curl -sSL https://install.python-poetry.org | python - -y
+
+    - name: 👗 » install nox
+      shell: bash
+      run: |
+        pip install nox nox-poetry
+
+    - name: 🧊 » install task
+      uses: arduino/setup-task@v1
+      with:
+        version: 3.x
+
+    - name: 🔀 » update PATH env var
+      shell: bash
+      run: echo "$HOME/.local/bin" >> $GITHUB_PATH
+
+    - name: 📜 » log sysinfo
+      shell: bash
+      run: |
+        uname -a
+        python --version
+        pip --version
+        poetry --version
+        task --version

.github/workflows/publish.yml

@@ -0,0 +1,53 @@
+name: "🚀 » publish"
+on:
+  release:
+    types: [published]
+
+concurrency:
+  group: publish-${{ github.ref }}
+  cancel-in-progress: true
+
+defaults:
+  run:
+    shell: 'bash'
+
+jobs:
+  publish-test-pypi:
+    name: 🚀 » publish to test.pypi ⚗️
+    if: ${{ github.event.act }}
+    runs-on: ubuntu-latest
+    environment: pypi-test
+    steps:
+      # checkout
+      - name: 📁 » checkout repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: 🚀 » build & publish to test.pypi
+        uses: JRubics/poetry-publish@v1.17
+        with:
+          ignore_dev_requirements: "yes"
+          pypi_token: ${{ secrets.PYPI_TOKEN }}
+          repository_name: "testpypi"
+          repository_url: "https://test.pypi.org/legacy/"
+
+  publish:
+    name: 🚀 » publish to pypi 🏭
+    if: ${{ !github.event.act }}
+    runs-on: ubuntu-latest
+    environment: pypi
+    steps:
+      # checkout
+      - name: 📁 » checkout repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: 🚀 » build & publish to test.pypi
+        uses: JRubics/poetry-publish@v1.17
+        with:
+          ignore_dev_requirements: "yes"
+          pypi_token: ${{ secrets.PYPI_TOKEN }}
+
+

.github/workflows/release.yml

@@ -0,0 +1,62 @@
+name: "🔖 » draft release"
+on:
+  workflow_call:
+  workflow_dispatch:
+
+concurrency:
+  group: release-${{ github.ref }}
+  cancel-in-progress: true
+
+defaults:
+  run:
+    shell: 'bash'
+
+jobs:
+  release:
+    name: "🔖 » draft release"
+    runs-on: ubuntu-latest
+    outputs:
+      release-note: ${{ steps.changelog.outputs.changelog }}
+      version: ${{ steps.version.outputs.local-version }}
+
+    steps:
+      - name: 📁 » checkout repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: ⬅️ » get previous git tag
+        id: tag
+        run: echo "last-tag=$(git describe --tags --abbrev=0 || git rev-list --max-parents=0 ${{github.ref}})" >> $GITHUB_OUTPUT
+
+      - name: 🏷️ » get versions
+        uses: ./.github/actions/check-version
+        id: version
+        with:
+          pyproject-path: "./pyproject.toml"
+
+      - name: 📑 » generate changelog
+        uses: lucaslabstech/action-release@v1.0.4
+        id: changelog
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          from: ${{ steps.tag.outputs.last-tag }}
+          to: ${{ github.ref }}
+          next-version: v${{ steps.version.outputs.local-version }}
+
+
+      - name: 🗑️ » delete outdated drafts
+        uses: hugo19941994/delete-draft-releases@v1.0.1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: 🔖 » create draft release
+        uses: ncipollo/release-action@v1.11.1
+        env:
+          GITHUB_TOKEN: ${{ secrets.github_token }}
+        with:
+          prerelease: false
+          draft: true
+          tag: v${{ steps.version.outputs.local-version }}
+          name: v${{ steps.version.outputs.local-version }}
+          body: ${{ steps.changelog.outputs.changelog }}

.github/workflows/test.yml

@@ -0,0 +1,68 @@
+name: "🧪 » test"
+on: 
+  workflow_call:
+  workflow_dispatch:
+
+concurrency:
+  group: tests-${{ github.ref }}
+  cancel-in-progress: true
+
+defaults:
+  run:
+    shell: 'bash'
+
+jobs:
+  lint:
+    name: "🧹 » lint"
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+
+    steps:
+      - name: 📁 » checkout repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: 🐍 » setup python, poetry and task
+        uses: ./.github/workflows/composites/setup
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: 📦 » install ruff globally
+        run: pip install ruff      
+
+      - name: 🧹 » lint
+        run: task lint:check
+
+  test:
+    name: "🧪 » tests"
+    runs-on: ubuntu-latest
+    needs: lint
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - name: 📁 » checkout repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: 🐍 » setup python, poetry and task
+        uses: ./.github/workflows/composites/setup
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: 🧪 » run tests
+        run: task test:${{ matrix.python-version }}
+
+      # if python 3.11, upload coverage to codecov
+      - name: ☂️ » upload coverage to codecov
+        if: matrix.python-version == '3.11'
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage.xml
+          verbose: true

.gitignore

@@ -1,5 +1,7 @@
 test.py
 
+.github/act-test
+
 # Created by https://www.toptal.com/developers/gitignore/api/python,visualstudiocode
 # Edit at https://www.toptal.com/developers/gitignore?templates=python,visualstudiocode
 

.vscode/settings.json

@@ -16,12 +16,12 @@
 
         // 🧪 tests
         // "tests": true,
-        "noxfile.py": true,
-        "conftest.py": true,
-        ".nox": true,
-        "htmlcov": true,
-        "coverage": true,
-        ".coverage": true,
+        // "noxfile.py": true,
+        // "conftest.py": true,
+        // ".nox": true,
+        // "htmlcov": true,
+        // "coverage": true,
+        // ".coverage": true,
 
         // 🗑️
         ".task": true, // task-go