|
1 |
| -name: Publish docs via GitHub Pages |
2 |
| - |
3 |
| -on: |
4 |
| - push: |
5 |
| - branches: |
6 |
| - - main |
7 |
| - workflow_dispatch: |
8 |
| - |
9 |
| -jobs: |
10 |
| - build: |
11 |
| - name: Deploy docs |
12 |
| - runs-on: ubuntu-latest |
13 |
| - |
14 |
| - steps: |
15 |
| - - name: Checkout main |
16 |
| - uses: actions/checkout@v2 |
17 |
| - |
18 |
| - - name: Set up Python |
19 |
| - uses: actions/setup-python@v2 |
20 |
| - with: |
21 |
| - python-version: '3.x' |
| 1 | +# name: Publish docs via GitHub Pages |
22 | 2 |
|
23 |
| - - name: Install dependencies |
24 |
| - run: | |
25 |
| - python -m pip install --upgrade pip |
26 |
| - pip install -r requirements.txt |
| 3 | +# on: |
| 4 | +# # push: |
| 5 | +# # branches: |
| 6 | +# # - main |
| 7 | +# workflow_dispatch: |
| 8 | +# release: |
| 9 | +# types: [published] |
| 10 | +# jobs: |
| 11 | +# build: |
| 12 | +# name: Deploy docs |
| 13 | +# runs-on: ubuntu-latest |
27 | 14 |
|
28 |
| - - name: Generate changelog |
29 |
| - run: python3 scripts/changelog.py |
| 15 | +# steps: |
| 16 | +# - name: Checkout main |
| 17 | +# uses: actions/checkout@v2 |
30 | 18 |
|
31 |
| - - name: Build MkDocs site |
32 |
| - run: mkdocs build |
| 19 | +# - name: Set up Python |
| 20 | +# uses: actions/setup-python@v2 |
| 21 | +# with: |
| 22 | +# python-version: '3.x' |
33 | 23 |
|
34 |
| - - name: Copy README to docs/index.md |
35 |
| - run: cp README.md docs/index.md |
| 24 | +# - name: Install dependencies |
| 25 | +# run: | |
| 26 | +# python -m pip install --upgrade pip |
| 27 | +# pip install -r requirements.txt |
36 | 28 |
|
37 |
| - - name: Copy CONTRIBUTING to docs/contribute.md |
38 |
| - run: cp CONTRIBUTING.md docs/contribute.md |
| 29 | +# - name: Generate changelog |
| 30 | +# run: python3 scripts/changelog.py |
39 | 31 |
|
40 |
| - - name: Copy CHANGELOG to docs/release-notes.md |
41 |
| - run: cp CHANGELOG.md docs/release-notes.md |
| 32 | +# - name: Build MkDocs site |
| 33 | +# run: mkdocs build |
42 | 34 |
|
43 |
| - - name: Configure git |
44 |
| - run: | |
45 |
| - git config --global user.name "github-actions[bot]" |
46 |
| - git config --global user.email "github-actions[bot]@users.noreply.github.com" |
| 35 | +# - name: Copy README to docs/index.md |
| 36 | +# run: cp README.md docs/index.md |
47 | 37 |
|
48 |
| - - name: Stash changes |
49 |
| - run: git stash --include-untracked |
| 38 | +# - name: Copy CONTRIBUTING to docs/contribute.md |
| 39 | +# run: cp CONTRIBUTING.md docs/contribute.md |
50 | 40 |
|
51 |
| - - name: Pull latest gh-pages |
52 |
| - run: | |
53 |
| - git fetch origin gh-pages |
54 |
| - git checkout gh-pages |
55 |
| - git pull origin gh-pages |
56 |
| - git checkout - |
| 41 | +# - name: Copy CHANGELOG to docs/release-notes.md |
| 42 | +# run: cp CHANGELOG.md docs/release-notes.md |
57 | 43 |
|
58 |
| - - name: Apply stash |
59 |
| - run: git stash pop |
| 44 | +# - name: Configure git |
| 45 | +# run: | |
| 46 | +# git config --global user.name "github-actions[bot]" |
| 47 | +# git config --global user.email "github-actions[bot]@users.noreply.github.com" |
60 | 48 |
|
61 |
| - - name: Deploy to GitHub Pages |
62 |
| - run: mkdocs gh-deploy --force |
63 |
| - env: |
64 |
| - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
| 49 | +# - name: Stash changes |
| 50 | +# run: git stash --include-untracked |
65 | 51 |
|
66 |
| -# name: Publish docs via GitHub Pages |
67 |
| -# on: |
68 |
| -# push: |
69 |
| -# branches: |
70 |
| -# - main |
| 52 | +# - name: Pull latest gh-pages |
| 53 | +# run: | |
| 54 | +# git fetch origin gh-pages |
| 55 | +# git checkout gh-pages |
| 56 | +# git pull origin gh-pages |
| 57 | +# git checkout - |
71 | 58 |
|
72 |
| -# jobs: |
73 |
| -# build: |
74 |
| -# name: Deploy docs |
75 |
| -# runs-on: ubuntu-latest |
76 |
| -# steps: |
77 |
| -# - name: Checkout main |
78 |
| -# uses: actions/checkout@v2 |
| 59 | +# - name: Apply stash |
| 60 | +# run: git stash pop |
79 | 61 |
|
80 |
| -# - name: Deploy docs |
81 |
| -# uses: mhausenblas/mkdocs-deploy-gh-pages@master |
82 |
| -# # Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme |
| 62 | +# - name: Deploy to GitHub Pages |
| 63 | +# run: mkdocs gh-deploy --force |
83 | 64 | # env:
|
84 | 65 | # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
85 |
| -# CUSTOM_DOMAIN: optionaldomain.com |
86 |
| -# CONFIG_FILE: folder/mkdocs.yml |
87 |
| -# EXTRA_PACKAGES: build-base |
88 |
| -# # GITHUB_DOMAIN: github.myenterprise.com |
89 |
| -# REQUIREMENTS: folder/requirements.txt |
| 66 | + |
| 67 | +# # name: Publish docs via GitHub Pages |
| 68 | +# # on: |
| 69 | +# # push: |
| 70 | +# # branches: |
| 71 | +# # - main |
| 72 | + |
| 73 | +# # jobs: |
| 74 | +# # build: |
| 75 | +# # name: Deploy docs |
| 76 | +# # runs-on: ubuntu-latest |
| 77 | +# # steps: |
| 78 | +# # - name: Checkout main |
| 79 | +# # uses: actions/checkout@v2 |
| 80 | + |
| 81 | +# # - name: Deploy docs |
| 82 | +# # uses: mhausenblas/mkdocs-deploy-gh-pages@master |
| 83 | +# # # Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme |
| 84 | +# # env: |
| 85 | +# # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
| 86 | +# # CUSTOM_DOMAIN: optionaldomain.com |
| 87 | +# # CONFIG_FILE: folder/mkdocs.yml |
| 88 | +# # EXTRA_PACKAGES: build-base |
| 89 | +# # # GITHUB_DOMAIN: github.myenterprise.com |
| 90 | +# # REQUIREMENTS: folder/requirements.txt |
0 commit comments