Merge pull request #5 from VinzentRisch/3_CI

MAINT: Added CI and switched from setup.py to pyproject.toml

.gitattributes

@@ -0,0 +1 @@
+pyproject.toml export-subst

.github/workflows/black.yaml

@@ -0,0 +1,13 @@
+name: Black
+
+on: [push, pull_request]
+
+jobs:
+  black:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: psf/black@stable
+        with:
+          version: "23.12.1"
+          options: ". --check --extend-exclude '.*_version\\.py$' --verbose"

.github/workflows/ci-dev.yaml

@@ -0,0 +1,13 @@
+name: CI
+on:
+  pull_request:
+    branches: ["main"]
+  push:
+    branches: ["main"]
+
+jobs:
+  ci:
+    uses: qiime2/distributions/.github/workflows/lib-ci-dev.yaml@dev
+    with:
+      distro: tiny
+      recipe-path: 'conda-recipe'

.github/workflows/ci.yaml

@@ -0,0 +1,126 @@
+name: Test
+on:
+  pull_request:
+    branches: ["main"]
+  push:
+    branches: ["main"]
+env:
+    DISTRO: tiny
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    outputs:
+      latest-dev-tag: ${{ steps.fetch_latest_tags.outputs.latest-dev-tag }}
+      latest-stable-tag: ${{ steps.fetch_latest_tags.outputs.latest-stable-tag }}
+      commit-msg: ${{ steps.get-commit-msg.outputs.commit-msg }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+            fetch-depth: 0
+
+      - name: Checkout utilities
+        uses: actions/checkout@v4
+        with:
+          repository: bokulich-lab/utilities
+          path: utilities
+
+      - name: Get last commit
+        id: get-commit-msg
+        run: |
+          commit_msg=$(git log --pretty=%B -n 1 --skip 1 2>/dev/null)
+          echo "commit-msg=$commit_msg" >> $GITHUB_OUTPUT
+
+      - name: Install dependencies
+        run: python -m pip install requests yq
+
+      - name: Fetch latest tags
+        id: fetch-tags
+        run: |
+          latest_tags=$(python utilities/ci/get-tags.py)
+          echo "$latest_tags" > tags.txt
+          echo "latest-dev-tag=$(grep 'latest-dev-tag' tags.txt | cut -d '=' -f 2)" >> $GITHUB_OUTPUT
+          echo "latest-stable-tag=$(grep 'latest-stable-tag' tags.txt | cut -d '=' -f 2)" >> $GITHUB_OUTPUT
+
+      - name: Create conda yaml
+        id: create-conda-yaml
+        run: |
+          commit_msg="${{ steps.get-commit-msg.outputs.commit-msg }}"
+          if [[ "$commit_msg" == *"[stable]"* ]] || [[ "$commit_msg" == *"[prod]"* ]]; then
+              tag="${{ steps.fetch-tags.outputs.latest-stable-tag }}"
+          else
+              tag="${{ steps.fetch-tags.outputs.latest-dev-tag }}"
+          fi
+          bash utilities/ci/get-dependencies.sh "$DISTRO" $tag utilities/ci/repositories.yaml
+          cat environment.yml >> $GITHUB_STEP_SUMMARY
+          echo "qiime-deps=$(tr '\n' ' ' < repo-urls.txt | xargs)" >> $GITHUB_OUTPUT
+
+      - name: Setup miniconda
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          python-version: "3.10"
+          mamba-version: "*"
+          channels: conda-forge,defaults
+          channel-priority: true
+          activate-environment: conda-env
+          condarc-file: utilities/ci/condarc
+          # use-only-tar-bz2: true
+
+      - name: Get date
+        id: get-date
+        run: echo "today=$(/bin/date -u '+%Y%m%d')" >> $GITHUB_OUTPUT
+        shell: bash
+
+      - name: Cache conda env
+        uses: actions/cache@v3
+        with:
+          path: /usr/share/miniconda/envs
+          key:
+            conda-${{ runner.os }}--${{ runner.arch }}--${{
+            steps.get-date.outputs.today }}-${{
+            hashFiles('environment.yml') }}-${{ env.CACHE_NUMBER
+            }}
+        env:
+          # Increase this value to reset cache if environment.yml has not changed
+          CACHE_NUMBER: 0
+        id: cache
+
+      - name: Update environment
+        run: mamba env update -n conda-env -f environment.yml
+        if: steps.cache.outputs.cache-hit != 'true'
+
+      - name: Install dev versions of QIIME repos
+        run: mamba run -n conda-env pip install ${{ steps.create-conda-yaml.outputs.qiime-deps }}
+
+      - name: Update specific dependency, if requested
+        if: contains(${{ steps.get-commit-msg.outputs.commit-msg }}, '[add:')
+        run: |
+            commit_msg="${{ steps.get-commit-msg.outputs.commit-msg }}"
+            IFS=',' read -ra ADDR <<< "$commit_msg"
+            for i in "${ADDR[@]}"; do
+                pkg_name=$(echo "$i" | awk -F':' '/\[add/{print $2}')
+                commit_hash=$(echo "$i" | awk -F':' '/\[add/{print $3}' | awk -F']' '{print $1}')
+                if [[ $(yq '.repositories[].name' utilities/ci/repositories.yaml | grep -c $pkg_name) -eq 1 ]]; then
+                    pkg_url=$(yq ".repositories[] | select(.name == \"$pkg_name\") | .url" utilities/ci/repositories.yaml | tr -d '"')
+                    mamba run -n conda-env pip install "git+$pkg_url@$commit_hash"
+                fi
+            done
+
+      - name: Install plugin
+        run: |
+          mamba run -n conda-env pip install .
+          mamba run -n conda-env qiime dev refresh-cache
+
+      - name: Install dev dependencies
+        run: mamba run -n conda-env pip install pytest pytest-cov coverage parameterized
+
+      - name: Run tests
+        id: test
+        run: mamba run -n conda-env make test-cov
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        if: steps.test.outcome == 'success'
+        with:
+          name: coverage
+          path: coverage.xml

.github/workflows/dependent-issues.yaml

@@ -0,0 +1,44 @@
+name: Dependent Issues
+
+on:
+  issues:
+    types:
+      - opened
+      - edited
+      - closed
+      - reopened
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - closed
+      - reopened
+      - synchronize
+
+  schedule:
+    - cron: '0 0 * * *'
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: z0al/dependent-issues@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_READ_TOKEN: ${{ secrets.GITHUB_READ_TOKEN }}
+
+        with:
+          label: dependent
+
+          # (Optional) Enable checking for dependencies in issues.
+          # Enable by setting the value to "on". Default "off"
+          check_issues: off
+
+          ignore_dependabot: off
+
+          keywords: depends on, blocked by, merge after
+
+          comment: >
+            This PR/issue depends on:
+
+            {{ dependencies }}

.github/workflows/join-release.yaml

@@ -0,0 +1,6 @@
+name: join-release
+on:
+  workflow_dispatch: {}
+jobs:
+  release:
+    uses: qiime2/distributions/.github/workflows/lib-join-release.yaml@dev

.github/workflows/q2-ci.yaml

@@ -0,0 +1,20 @@
+name: "QIIME2: build and test"
+on: issue_comment
+
+jobs:
+  react:
+    if: ${{ github.event.issue.pull_request && contains(github.event.comment.body, '/q2ci') }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: peter-evans/create-or-update-comment@v4
+        with:
+          comment-id: ${{ github.event.comment.id }}
+          body: |
+            <br /> **Edit:** Running QIIME 2 CI...
+          reactions: "+1"
+
+  ci:
+    if: ${{ github.event.issue.pull_request && contains(github.event.comment.body, '/q2ci') }}
+    uses: qiime2/distributions/.github/workflows/lib-ci-dev.yaml@dev
+    with:
+      distro: tiny

.github/workflows/tag-release.yaml

@@ -0,0 +1,7 @@
+name: tag-release
+on:
+  push:
+    branches: ["Release-*"]
+jobs:
+  tag:
+    uses: qiime2/distributions/.github/workflows/lib-tag-release.yaml@dev

.github/workflows/upload-coverage.yaml

@@ -0,0 +1,66 @@
+name: Upload coverage report
+
+on:
+  workflow_run:
+    workflows: ["Test"]
+    types:
+      - completed
+
+jobs:
+  upload-coverage:
+    runs-on: ubuntu-latest
+    if: >
+      github.event.workflow_run.event == 'pull_request' &&
+      github.event.workflow_run.conclusion == 'success'
+    steps:
+      - name: 'Download artifact'
+        uses: actions/[email protected]
+        with:
+          script: |
+            var artifacts = await github.rest.actions.listWorkflowRunArtifacts({
+               owner: context.repo.owner,
+               repo: context.repo.repo,
+               run_id: ${{github.event.workflow_run.id }},
+            });
+            var matchArtifact = artifacts.data.artifacts.filter((artifact) => {
+              return artifact.name == "coverage"
+            })[0];
+            var download = await github.rest.actions.downloadArtifact({
+               owner: context.repo.owner,
+               repo: context.repo.repo,
+               artifact_id: matchArtifact.id,
+               archive_format: 'zip',
+            });
+            var fs = require('fs');
+            fs.writeFileSync('${{github.workspace}}/coverage.zip', Buffer.from(download.data));
+
+      - run: unzip coverage.zip
+
+      - name: Find associated PR
+        id: pr
+        uses: actions/[email protected]
+        with:
+          script: |
+            const response = await github.rest.search.issuesAndPullRequests({
+              q: 'repo:${{ github.repository }} is:pr sha:${{ github.event.workflow_run.head_sha }}',
+              per_page: 1,
+            })
+            const items = response.data.items
+            if (items.length < 1) {
+              console.error('No PRs found')
+              return
+            }
+            const pullRequestNumber = items[0].number
+            console.info("Pull request number is", pullRequestNumber)
+            return pullRequestNumber
+
+      - uses: codecov/codecov-action@v4
+        name: Upload coverage report
+        with:
+          files: ./coverage.xml
+          fail_ci_if_error: true
+          override_pr: ${{ steps.pr.outputs.result }}
+          override_commit: ${{ github.event.workflow_run.head_sha }}
+          verbose: true
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -163,4 +163,7 @@ cython_debug/
 #.idea/
 
 # macOS
-.DS_Store
+.DS_Store
+
+# Version file from versioningit
+_version.py