ci: add auto updates of docs #2
Workflow file for this run
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
name: "Automatic doc generation" | ||
on: | ||
pull_request: | ||
branches: | ||
- main | ||
- develop | ||
jobs: | ||
generate-docs: | ||
runs-on: ubuntu-latest | ||
env: | ||
isPR: ${{ github.event.pull_request.base.ref == 'develop' || github.event.pull_request.base.ref == 'main' }} | ||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v2 | ||
- name: Set up Python | ||
uses: actions/setup-python@v2 | ||
with: | ||
python-version: '3.7' | ||
- name: Install dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
pip install poetry | ||
poetry install | ||
- name: Generate docs | ||
run: python splunk_add_on_ucc_framework/generators/doc_generator.py | ||
- name: Import GPG key | ||
if: ${{ env.isPR }} | ||
uses: crazy-max/ghaction-import-gpg@v6 | ||
with: | ||
git_committer_name: ${{ secrets.SA_GH_USER_NAME }} | ||
git_committer_email: ${{ secrets.SA_GH_USER_EMAIL }} | ||
gpg_private_key: ${{ secrets.SA_GPG_PRIVATE_KEY }} | ||
passphrase: ${{ secrets.SA_GPG_PASSPHRASE }} | ||
git_user_signingkey: true | ||
git_commit_gpgsign: true | ||
- name: Push updated screenshots | ||
if: ${{ env.isPR }} | ||
run: | | ||
git add \*.md | ||
git diff --staged --exit-code || (git commit -S -m "doc: updated docs regarding generated conf, xml and html files" && git push) | ||