Skip to content

Commit

Permalink
Update workflows
Browse files Browse the repository at this point in the history
Signed-off-by: Brian Warner <[email protected]>
  • Loading branch information
brianwarner committed Nov 24, 2024
1 parent a2402e7 commit bbb2af3
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 25 deletions.
19 changes: 11 additions & 8 deletions .github/workflows/pre-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,6 @@ on:
- '**'
- '!main'

permissions:
contents: write
pull-requests: write

jobs:
test:
name: Test Python versions
Expand All @@ -29,7 +25,7 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install flake8 pytest
python -m pip install flake8 pytest pytest-pretty
- name: Lint with flake8
run: |
# stop the build if there are Python syntax errors or undefined names
Expand All @@ -40,26 +36,33 @@ jobs:
run: |
pytest
build:
name: Build and generate documentation
name: Regenerate documentation
needs: test
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.x'
python-version: '3.12'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install build setuptools setuptools-scm sphinx sphinx_rtd_theme myst_parser
python -m pip install -r requirements-dev.txt
- name: Build the packages
run: |
python -m build
- name: Generate documentation
run: |
sphinx-build -b html docsrc docs -E -d "docsrc/_doctrees"
- name: Check if there are any changes
id: verify_diff
run: |
git diff --quiet . || echo "changed=true" >> $GITHUB_OUTPUT
- name: Commit and push the new documentation
if: steps.verify_diff.outputs.changed == 'true'
run: |
git config user.name "Brian Warner"
git config user.email [email protected]
Expand Down
22 changes: 5 additions & 17 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Test, build, generate docs, and publish to PyPI
name: Test and publish to PyPI

on:
push:
Expand All @@ -21,7 +21,7 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install flake8 pytest
python -m pip install flake8 pytest pytest-pretty
- name: Lint with flake8
run: |
# stop the build if there are Python syntax errors or undefined names
Expand All @@ -32,35 +32,23 @@ jobs:
run: |
pytest
pypi-publish:
name: Upload release to PyPI and update documentation
name: Upload release to PyPI
needs: test
runs-on: ubuntu-latest
environment: release
permissions:
id-token: write
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.x'
python-version: '3.12'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install build setuptools setuptools-scm sphinx sphinx_rtd_theme myst_parser
python -m pip install -r requirements-dev.txt
- name: Build the packages
run: |
python -m build
- name: Publish package distributions to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
- name: Generate documentation with latest version
run: |
sphinx-build -b html docsrc docs -E -d "docsrc/_doctrees"
- name: Commit and push the new documentation
if: steps.verify_diff.outputs.changed == 'true'
run: |
git config user.name "Brian Warner"
git config user.email [email protected]
git add docs
git commit -m "Rebuild the documentation" || exit 0
git push

0 comments on commit bbb2af3

Please sign in to comment.