Skip to content

Multi bundle docs workflow #4

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

Open
astrogeco wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Multi bundle docs workflow #4

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7de5b76
Test docs build against multiple bundle branches
astrogeco Jun 15, 2021
06c0064
Add matrix build to usersguide
astrogeco Jun 15, 2021
68ab500
Update doc folder
astrogeco Jun 15, 2021
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
23 changes: 19 additions & 4 deletions .github/workflows/build-documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ env:

jobs:

#Check for duplicate actions. Skips push actions if there is a matching or duplicate pull-request action.
# Check for duplicate actions. Skips push actions if there is a matching or
# duplicate pull-request action.
check-for-duplicates:
runs-on: ubuntu-latest
# Map a step output to a job output
Expand All @@ -25,12 +26,18 @@ jobs:
do_not_skip: '["pull_request", "workflow_dispatch", "schedule"]'

build-docs:
#Continue if check-for-duplicates found no duplicates. Always runs for pull-requests.
# Continue if check-for-duplicates found no duplicates. Always runs for
# pull-requests.
needs: check-for-duplicates
if: ${{ needs.check-for-duplicates.outputs.should_skip != 'true' }}
runs-on: ubuntu-18.04
timeout-minutes: 15

strategy:
fail-fast: false
matrix:
bundle-branch: [main, integration-candidate]

steps:
- name: Install Dependencies
run: sudo apt-get install doxygen graphviz -y
Expand All @@ -41,6 +48,7 @@ jobs:
with:
repository: nasa/cFS
submodules: true
ref: ${{matrix.bundle-branch}}

- name: Checkout submodule
uses: actions/checkout@v2
Expand Down Expand Up @@ -78,12 +86,18 @@ jobs:
fi

build-usersguide:
#Continue if check-for-duplicates found no duplicates. Always runs for pull-requests.
# Continue if check-for-duplicates found no duplicates. Always runs for
# pull-requests.
needs: check-for-duplicates
if: ${{ needs.check-for-duplicates.outputs.should_skip != 'true' }}
runs-on: ubuntu-18.04
timeout-minutes: 15

strategy:
fail-fast: false
matrix:
bundle-branch: [main, integration-candidate]

steps:
- name: Install Dependencies
run: sudo apt-get install doxygen graphviz -y
Expand All @@ -94,6 +108,7 @@ jobs:
with:
repository: nasa/cFS
submodules: true
ref: ${{matrix.bundle-branch}}

- name: Checkout submodule
uses: actions/checkout@v2
Expand All @@ -113,7 +128,7 @@ jobs:
- name: Build Usersguide
run: |
make usersguide > make_usersguide_stdout.txt 2> make_usersguide_stderr.txt
mv build/doc/warnings.log usersguide_warnings.log
mv build/docs/warnings.log usersguide_warnings.log

- name: Archive Users Guide Build Logs
uses: actions/upload-artifact@v2
Expand Down