Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Test env variables for user name and email in Build docs action #24

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+41 −4
Open

Test env variables for user name and email in Build docs action #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 41 additions & 4 deletions .github/workflows/build-sphinx.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,36 @@ on:
types: [opened, synchronize, reopened, closed]

env:
GITHUB_BOT_NAME: 'github-actions[bot]'
GITHUB_BOT_EMAIL: 'github-actions[bot]@users.noreply.github.com'
PUBLISH_DIR: doc/_build/html/
GH_EVENT_PUSH: ${{ github.ref == 'refs/heads/master' && github.event_name == 'push' &&
github.event.ref == 'refs/heads/master' && github.event.repository }}
GH_EVENT_PUSH_UPSTREAM: ${{ github.ref == 'refs/heads/master' && github.event_name == 'push' &&
github.event.ref == 'refs/heads/master' && github.event.repository && !github.event.repository.fork }}
GH_EVENT_PR: ${{ github.event_name == 'pull_request' && github.event.pull_request != null }}
GH_EVENT_PR_UPSTREAM: ${{ github.event_name == 'pull_request' && github.event.pull_request && !github.event.pull_request.head.repo.fork }}

defaults:
run:
shell: bash -l {0}

jobs:
test:
if: ${{ env.GH_EVENT_PR }}

runs-on: ubuntu-20.04

steps:
- name: Cancel Previous Runs
uses: styfle/[email protected]
with:
access_token: ${{ github.token }}

- name: Test step
run: |
echo "Test job is done"

build-and-deploy:
name: Build and Deploy Docs

Expand All @@ -29,11 +52,23 @@ jobs:
with:
access_token: ${{ github.token }}

- name: Test step
if: env.GH_EVENT_PR && github.event.action != 'closed'
run: |
echo "Test step is done"

- name: Dump GitHub context
env:
GITHUB_CONTEXT: ${{ toJson(github) }}
run: |
echo "$GITHUB_CONTEXT"
echo "GITHUB_BOT_NAME=${{ env.GITHUB_BOT_NAME }}"
echo "GITHUB_BOT_EMAIL=${{ env.GITHUB_BOT_EMAIL }}"
echo "GH_EVENT_PUSH=${{ env.GH_EVENT_PUSH }}"
echo "GH_EVENT_PUSH_UPSTREAM=${{ env.GH_EVENT_PUSH_UPSTREAM }}"
echo "GH_EVENT_PR=${{ env.GH_EVENT_PR }}"
echo "GH_EVENT_EMPTY_PR=${{ env.GH_EVENT_EMPTY_PR }}"
echo "GH_EVENT_PR_UPSTREAM=${{ env.GH_EVENT_PR_UPSTREAM }}"

- name: Free Disk Space (Ubuntu)
uses: jlumbroso/free-disk-space@main
Expand Down Expand Up @@ -136,6 +171,8 @@ jobs:
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ${{ env.PUBLISH_DIR }}
user_name: ${{ env.GITHUB_BOT_NAME }}
user_email: ${{ env.GITHUB_BOT_EMAIL }}

- name: Publish pull-request docs
if: |
Expand All @@ -149,8 +186,8 @@ jobs:
keep_files: true
commit_message: ${{ github.event.head_commit.message }}
publish_branch: gh-pages
user_name: 'github-actions[bot]'
user_email: 'github-actions[bot]@users.noreply.github.com'
user_name: ${{ env.GITHUB_BOT_NAME }}
user_email: ${{ env.GITHUB_BOT_EMAIL }}

- name: Comment with URL to published pull-request docs
if: |
Expand Down Expand Up @@ -185,8 +222,8 @@ jobs:
git checkout --track tokened_docs/gh-pages
echo `pwd`
[ -d pull/${PR_NUM} ] && git rm -rf pull/${PR_NUM}
git config --global user.name 'github-actions[bot]'
git config --global user.email 'github-actions[bot]@users.noreply.github.com'
git config --global user.name ${{ env.GITHUB_BOT_NAME }}
git config --global user.email ${{ env.GITHUB_BOT_EMAIL }}
git commit -m "Removing docs for closed pull request ${PR_NUM}"
git push tokened_docs gh-pages

Expand Down