Update README.md for dark mode #83
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
| name: CI Pipeline | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - develop | |
| pull_request: | |
| branches: | |
| - main | |
| - develop | |
| permissions: | |
| contents: write | |
| checks: write | |
| pull-requests: write | |
| jobs: | |
| test: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ['3.10'] | |
| steps: | |
| - name: Check out the repository | |
| uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install Poetry | |
| run: | | |
| curl -sSL https://install.python-poetry.org | python3 - | |
| export PATH="$HOME/.local/bin:$PATH" | |
| - name: Install project with dev dependencies | |
| run: | | |
| poetry install --with dev | |
| # Step to detect if the commit is a merge commit (skip CI on merge commits) | |
| - name: Check if commit is a merge commit | |
| id: check-merge | |
| run: | | |
| if git log -1 --pretty=%B | grep -q "Merge pull request"; then | |
| echo "is-merge=true" >> $GITHUB_ENV | |
| else | |
| echo "is-merge=false" >> $GITHUB_ENV | |
| fi | |
| # Step to detect changes in pyproject.toml or poetry.lock | |
| - name: Check for dependency changes | |
| id: check-deps | |
| if: env.is-merge == 'false' # Skip if it's a merge commit | |
| run: | | |
| if git diff --name-only HEAD~1 | grep -qE 'pyproject.toml|poetry.lock'; then | |
| echo "dependencies-changed=true" >> $GITHUB_ENV | |
| else | |
| echo "dependencies-changed=false" >> $GITHUB_ENV | |
| fi | |
| # Step to generate requirements.txt if dependencies have changed | |
| - name: Generate requirements.txt | |
| if: env.is-merge == 'false' && env.dependencies-changed == 'true' | |
| run: | | |
| poetry export -f requirements.txt --output requirements.txt --without-hashes | |
| # Commit and push the updated requirements.txt if dependencies have changed | |
| - name: Commit and push updated requirements.txt | |
| if: env.is-merge == 'false' && env.dependencies-changed == 'true' | |
| run: | | |
| git config --global user.name 'github-actions[bot]' | |
| git config --global user.email 'github-actions[bot]@users.noreply.github.com' | |
| git add requirements.txt | |
| git commit -m "Update requirements.txt [skip ci]" | |
| git push | |
| # Run Black (auto-reformat) using Poetry | |
| - name: Run Black (auto-reformat) | |
| if: env.is-merge == 'false' # Skip if it's a merge commit | |
| run: | | |
| poetry run black . | |
| # Run isort (auto-reformat) using Poetry | |
| - name: Run isort (auto-reformat) | |
| if: env.is-merge == 'false' # Skip if it's a merge commit | |
| run: | | |
| poetry run isort . | |
| # Run pytest using Poetry | |
| - name: Run pytest and generate coverage report | |
| if: env.is-merge == 'false' # Skip if it's a merge commit | |
| run: | | |
| poetry run pytest --cov-report=term-missing:skip-covered --cov=codes test/ --cov-report=xml:coverage.xml | |
| # - name: Pytest coverage comment | |
| # if: env.is-merge == 'false' # Skip if it's a merge commit | |
| # uses: MishaKav/pytest-coverage-comment@main | |
| # with: | |
| # pytest-coverage-path: ./pytest-coverage.txt | |
| - name: Upload results to Codecov | |
| if: env.is-merge == 'false' # Skip if it's a merge commit | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} # Only needed for private repos | |
| files: ./coverage.xml # Path to the coverage XML file, adjust if necessary | |
| fail_ci_if_error: true # Optional, ensures the CI fails if Codecov upload fails | |
| docs: | |
| if: github.ref == 'refs/heads/main' || github.event.pull_request.base.ref == 'main' # Only run on the main branch or PRs targeting main | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ['3.10'] | |
| steps: | |
| - name: Check out the repository | |
| uses: actions/checkout@v3 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| # Install Poetry | |
| - name: Install Poetry | |
| run: | | |
| curl -sSL https://install.python-poetry.org | python3 - | |
| export PATH="$HOME/.local/bin:$PATH" | |
| # Install project dependencies, including dev dependencies | |
| - name: Install project with dev dependencies | |
| run: | | |
| poetry install --with dev | |
| # Generate Sphinx Documentation | |
| - name: Generate API Documentation with Sphinx | |
| run: | | |
| poetry run sphinx-apidoc -o docs/ codes | |
| # Build HTML using Sphinx | |
| - name: Build HTML with Sphinx | |
| run: | | |
| poetry run sphinx-build -b html docs/ docs/_build | |
| # Deploy Sphinx API documentation to gh-pages | |
| - name: Deploy Sphinx API docs to gh-pages | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: docs/_build | |
| publish_branch: gh-pages | |
| user_name: "GitHub Actions" | |
| user_email: "actions@github.com" |