Skip to content

Commit

Permalink
feat(ci): Add release CI workflow
Browse files Browse the repository at this point in the history
Only contains docs publishing for now, since we have not agreed
on a PyPI package name just yet.
  • Loading branch information
AdrianoKF committed Aug 2, 2024
1 parent 9bb9f8b commit 343ce96
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 0 deletions.
12 changes: 12 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# top-most EditorConfig file
root = true

# Apply the following rules to all files
[*]
# Unix-style newlines with a newline ending every file
# A mix of line endings can lead to various problems, e.g., when running scripts in
# containers or when versioning python scripts based on the hash of the source file.
end_of_line = lf
# Consistency
insert_final_newline = true
indent_size = 2
45 changes: 45 additions & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Release

on:
workflow_dispatch:
release:
types:
- released

permissions:
contents: write

jobs:
build-release:
runs-on: ubuntu-latest
name: Deploy documentation to GitHub Pages
concurrency: docs
steps:
- uses: actions/checkout@v4
- name: Set up Python and dependencies
uses: ./.github/actions/python-deps
with:
pythonVersion: "3.11"
# Package build
- name: Build and check
run: |
python -m build
- name: Upload build artifacts
uses: actions/upload-artifact@v4
with:
name: dist
path: dist
# Docs
- name: Build release documentation
run: mkdocs build
- name: Archive built documentation
uses: actions/upload-artifact@v4
with:
name: docs
path: public/docs
- name: Deploy release documentation
uses: ./.github/actions/mike-docs
with:
version: ${{ github.event.release.tag_name }}
alias: latest
push: true

0 comments on commit 343ce96

Please sign in to comment.