-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Only contains docs publishing for now, since we have not agreed on a PyPI package name just yet.
- Loading branch information
Showing
2 changed files
with
57 additions
and
0 deletions.
There are no files selected for viewing
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
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 |
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
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 |