mirror of https://github.com/k3d-io/k3d
commit
149dfdb9ab
@ -0,0 +1,46 @@ |
||||
name: k3d.io |
||||
|
||||
on: |
||||
push: |
||||
branches: |
||||
- main |
||||
tags: |
||||
# only run on tags for real releases and special docs releases |
||||
- 'v[0-9]+.[0-9]+.[0-9]+' |
||||
- 'v[0-9]+.[0-9]+.[0-9]+-docs.[0-9]+' |
||||
# tags-ignore: |
||||
# - "*rc*" |
||||
# - "*beta*" |
||||
# - "*alpha*" |
||||
# - "*test*" |
||||
# - "*dev*" |
||||
|
||||
jobs: |
||||
build: |
||||
runs-on: ubuntu-20.04 |
||||
container: |
||||
image: python:3.9 |
||||
steps: |
||||
- name: Checkout Project |
||||
uses: actions/checkout@v2 |
||||
with: |
||||
fetch-depth: 0 |
||||
- name: Install Requirements |
||||
run: pip install -r docs/requirements.txt |
||||
- name: Build with MkDocs (validation) |
||||
run: | |
||||
mkdocs build --verbose --clean --strict |
||||
rm -r site/ |
||||
- name: Configure Git |
||||
if: startsWith(github.ref, 'refs/tags/') |
||||
id: git |
||||
run: | |
||||
git config --global user.name ghaction-k3d.io |
||||
git config --global user.email ghaction@k3d.io |
||||
echo ::set-output name=tag::${GITHUB_REF#refs/tags/} |
||||
- name: Build & Deploy with Mike (versioned) |
||||
if: startsWith(github.ref, 'refs/tags/') |
||||
run: | |
||||
mike deploy --update-aliases --push --rebase ${{ steps.git.outputs.tag }} stable |
||||
|
||||
|
@ -1,7 +1,8 @@ |
||||
mkdocs |
||||
mkdocs-material |
||||
pymdown-extensions |
||||
mkdocs-git-revision-date-localized-plugin |
||||
mkdocs-awesome-pages-plugin |
||||
mdx_truly_sane_lists |
||||
mkdocs-include-markdown-plugin # https://github.com/mondeja/mkdocs-include-markdown-plugin |
||||
mkdocs==1.2.2 |
||||
mkdocs-material==7.2.6 |
||||
pymdown-extensions==8.2 |
||||
mkdocs-git-revision-date-localized-plugin==0.9.3 |
||||
mkdocs-awesome-pages-plugin==2.5.0 |
||||
mdx_truly_sane_lists==1.2 # https://github.com/radude/mdx_truly_sane_lists |
||||
mkdocs-include-markdown-plugin==3.2.2 # https://github.com/mondeja/mkdocs-include-markdown-plugin |
||||
mike==1.1.0 # versioned docs: https://github.com/jimporter/mike |
||||
|
Loading…
Reference in new issue