forked from flyteorg/flyte
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added Github workflow for generating docs (flyteorg#85)
- Loading branch information
Showing
1 changed file
with
54 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,54 @@ | ||
name: Generate Documentation | ||
|
||
on: | ||
push: | ||
branches: | ||
- master | ||
|
||
jobs: | ||
build: | ||
name: Generate documentation | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
with: | ||
lfs: true | ||
- uses: actions/setup-go@v1 | ||
with: | ||
go-version: '1.16' | ||
- uses: actions/setup-python@v1 | ||
with: | ||
python-version: 3.9 | ||
- uses: actions/cache@v2 | ||
with: | ||
path: ~/.cache/pip | ||
key: docs-pip-${{ runner.os }}-${{ hashFiles('doc-requirements.txt') }}-${{ hashFiles('doc-requirements.in') }} | ||
restore-keys: docs-pip- | ||
- name: Install Dependencies | ||
run: | | ||
# Install all requirments | ||
pip install -r doc-requirements.txt | ||
- name: Generate documentation | ||
run: | | ||
make -C docs gendocs | ||
- name: Create Pull Request | ||
id: cpr | ||
uses: peter-evans/create-pull-request@v3 | ||
with: | ||
token: ${{ secrets.FLYTE_BOT_PAT }} | ||
commit-message: Update documentation | ||
committer: Flyte-Bot <[email protected]> | ||
author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com> | ||
signoff: true | ||
branch: flyte-bot-update-documentation | ||
delete-branch: true | ||
title: 'Update documentation' | ||
body: | | ||
Update documentation | ||
- Auto-generated by [flyte-bot] | ||
labels: | | ||
documentation | ||
team-reviewers: | | ||
owners | ||
maintainers | ||
draft: false |