-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1556 from caracal-pipeline/publish_docs
Publish the docs
- Loading branch information
Showing
1 changed file
with
60 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,60 @@ | ||
# This workflow uses actions that are not certified by GitHub. | ||
# They are provided by a third-party and are governed by | ||
# separate terms of service, privacy policy, and support | ||
# documentation. | ||
|
||
name: Upload to Read the docs | ||
|
||
on: | ||
push: | ||
branches: [ master ] | ||
|
||
jobs: | ||
deploy: | ||
|
||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v2 | ||
- name: Set up Python | ||
uses: actions/setup-python@v2 | ||
with: | ||
python-version: '3.x' | ||
- name: Install dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
pip install sphinx sphinx-rtd-theme | ||
pip install recommonmark | ||
pip install ruamel.yaml==0.17.21 | ||
- name: Clone caracal-docs repo | ||
run: git clone https://github.com/caracal-pipeline/caracal-docs.git ../caracal-docs/ | ||
|
||
- uses: actions/checkout@v4 | ||
- name: Make changes to pull request | ||
run: | | ||
cd ../caracal-docs | ||
python make_caracal_docs.py | ||
cd sphinx && make html | ||
git status | ||
git add _build/html | ||
- name: Create Pull Request | ||
id: cpr | ||
uses: peter-evans/create-pull-request@v5 | ||
with: | ||
token: ${{ secrets.GITHUB_TOKEN }} | ||
commit-message: Update report | ||
committer: GitHub <[email protected]> | ||
author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com> | ||
signoff: false | ||
branch: readthedocs | ||
delete-branch: true | ||
title: 'Read the docs updates' | ||
body: | | ||
Update report | ||
- Auto-generated by caracal | ||
labels: | | ||
automated pr | ||
assignees: athanaseus | ||
reviewers: paoloserra | ||
draft: false |