generated from roboflow/template-python
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ci: π· supervision documentation π release CI added
Signed-off-by: Onuralp SEZER <[email protected]>
- Loading branch information
1 parent
f4f9b3d
commit bba38dc
Showing
2 changed files
with
71 additions
and
0 deletions.
There are no files selected for viewing
File renamed without changes.
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,71 @@ | ||
name: Supervision Release Documentation Workflow π | ||
on: | ||
push: | ||
tags: | ||
- '[0-9]+.[0-9]+[0-9]+.[0-9]' | ||
branches-ignore: | ||
- 'develop' | ||
- 'docs*' | ||
- 'refs/heads/docs*' | ||
- 'refs/heads/feat*' | ||
- 'refs/heads/fix*' | ||
- 'refs/heads/hotfix*' | ||
- 'refs/heads/bugfix*' | ||
- 'refs/tags/[a-zA-Z]*' | ||
|
||
|
||
|
||
workflow_dispatch: | ||
|
||
concurrency: | ||
group: ${{ github.workflow }}-${{ github.event_name == 'push' && github.ref}} | ||
cancel-in-progress: true | ||
|
||
permissions: | ||
contents: write | ||
pages: write | ||
pull-requests: write | ||
|
||
|
||
jobs: | ||
doc-build-deploy: | ||
if: startsWith(github.ref, 'refs/tags/') | ||
runs-on: ubuntu-latest | ||
strategy: | ||
matrix: | ||
python-version: ["3.10"] | ||
steps: | ||
- name: ποΈ Checkout | ||
uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 0 | ||
ref: ${{ github.head_ref }} | ||
|
||
- name: π Set up Python | ||
uses: actions/setup-python@v5 | ||
with: | ||
python-version: '3.10' | ||
- name: π¦ Install mkdocs-material | ||
run: pip install "mkdocs-material" | ||
- name: π¦ Install mkdocstrings[python] | ||
run: pip install "mkdocstrings[python]" | ||
- name: π¦ Install mkdocs-material[imaging] | ||
run: pip install "mkdocs-material[imaging]" | ||
- name: π¦ Install mike | ||
run: pip install "mike" | ||
- name: π¦ Install mkdocs-git-revision-date-localized-plugin | ||
run: pip install "mkdocs-git-revision-date-localized-plugin" | ||
- name: π¦ Install JupyterLab | ||
run: pip install jupyterlab | ||
- name: π¦ Install mkdocs-jupyter | ||
run: pip install mkdocs-jupyter | ||
- name: π¦ Install mkdocs-git-committers-plugin-2 | ||
run: pip install mkdocs-git-committers-plugin-2 | ||
- name: βοΈ Configure git for github-actions π· | ||
run: | | ||
git config --global user.name "github-actions[bot]" | ||
git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com" | ||
- name: π Deploy MkDoc-Material π | ||
run: | | ||
latest_tag=$(git describe --tags `git rev-list --tags --max-count=1`) | ||
MKDOCS_GIT_COMMITTERS_APIKEY=${{ secrets.GITHUB_TOKEN }} mike deploy --push --update-aliases $latest_tag latest |