CI: deploy: automate docs

- fixes https://github.com/tqdm/tqdm.github.io/issues/4
This commit is contained in:
Casper da Costa-Luis 2020-07-15 22:55:36 +01:00
parent b168c391da
commit 830cd7f9cb
No known key found for this signature in database
GPG Key ID: 986B408043AE090D
2 changed files with 36 additions and 5 deletions

View File

@ -6,16 +6,47 @@ jobs:
wiki:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Checkout repo
uses: actions/checkout@v2
- name: Checkout wiki
uses: actions/checkout@v2
with:
repository: ${{ github.repository }}.wiki
- name: Update Releases
path: wiki
- name: Checkout docs
uses: actions/checkout@v2
with:
repository: ${{ github.repository }}.github.io
path: docs
ref: src
token: ${{ secrets.GH_TOKEN }}
- uses: actions/setup-python@v2
with:
python-version: '3.x'
- name: Install
run: |
pip install -U wheel argopt tqdm
pip install -U ./docs/
- name: Update Wiki Releases
run: |
pushd wiki
make
git config user.email "$GIT_AUTHOR_EMAIL"
git config user.name "$GIT_AUTHOR_NAME"
git commit -a -m "update release notes to ${GITHUB_REF#refs/tags/}"
git push
popd
env:
GIT_AUTHOR_NAME: ${{ github.event.sender.login }}
GIT_AUTHOR_EMAIL: ${{ github.event.sender.login }}@users.noreply.github.com
- name: Update Docs
run: |
pushd docs
git fetch origin master:master
git config user.email "$GIT_AUTHOR_EMAIL"
git config user.name "$GIT_AUTHOR_NAME"
make deploy
popd
env:
GIT_AUTHOR_NAME: ${{ github.event.sender.login }}
GIT_AUTHOR_EMAIL: ${{ github.event.sender.login }}@users.noreply.github.com

View File

@ -341,7 +341,7 @@ to assist with maintenance.
+ allows maintainers to write `/tag vM.m.p commit_hash` in an issue/PR to create a tag
- Post Release
+ automatically updates the [wiki]
+ TODO: automatically updates the [gh-pages root]
+ automatically updates the [gh-pages root]
- Benchmark
+ automatically updates the [gh-pages project]
@ -375,7 +375,7 @@ Much is automated so really it's steps 1-6, then 12(a).
b) **`[AUTO:TravisCI]`** attach `dist/tqdm-*` binaries
(usually only `*.whl*`)
13. **`[SUB][AUTO:GHActions]`** run `make` in the `wiki` submodule to update release notes
14. **`[SUB]`** run `make deploy` in the `docs` submodule to update website
14. **`[SUB][AUTO:GHActions]`** run `make deploy` in the `docs` submodule to update website
15. **`[SUB][AUTO:GHActions]`** accept the automated PR in the `feedstock` submodule to update conda
16. **`[AUTO:GHActions]`** update the [gh-pages project] benchmarks
a) `[python setup.py] make testasvfull`
@ -384,5 +384,5 @@ Much is automated so really it's steps 1-6, then 12(a).
Key:
- **`[AUTO:TravisCI]`**: Travis CI should automatically do this after `git push --tags` (6)
- **`[AUTO:GHActions]`**: GitHub Actions CI should automatically do this
- **`[AUTO:GHActions]`**: GitHub Actions CI should automatically do this after release (12a)
- **`[SUB]`**: Requires one-time `make submodules` to clone `docs`, `wiki`, and `feedstock`