Skip to content

IC: equuleus-rc1+dev13 #1949

IC: equuleus-rc1+dev13

IC: equuleus-rc1+dev13 #1949

name: cFS Documentation and Guides
on:
push:
pull_request:
# Force bash to apply pipefail option so pipeline failures aren't masked
defaults:
run:
shell: bash
jobs:
# Checks for duplicate actions. Skips push actions if there is a matching or
# duplicate pull-request action.
checks-for-duplicates:
runs-on: ubuntu-latest
# Map a step output to a job output
outputs:
should_skip: ${{ steps.skip_check.outputs.should_skip }}
steps:
- id: skip_check
uses: fkirc/skip-duplicate-actions@master
with:
concurrent_skipping: 'same_content'
skip_after_successful_duplicate: 'true'
do_not_skip: '["pull_request", "workflow_dispatch", "schedule"]'
checkout-and-cache:
name: Custom checkout and cache for cFS documents
needs: checks-for-duplicates
if: ${{ needs.checks-for-duplicates.outputs.should_skip != 'true' || contains(github.ref, 'main') }}
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
submodules: true
- name: Cache Source and Build
id: cache-src-bld
uses: actions/cache@v4
with:
path: /home/runner/work/${{ github.event.repository.name }}/${{ github.event.repository.name }}/*
key: cfs-doc-${{ github.run_number }}
build-cfs-documentation:
needs: checkout-and-cache
name: Build cFS documents
uses: nasa/cFS/.github/workflows/build-deploy-doc.yml@main
with:
target: "[\"cfe-usersguide\", \"osal-apiguide\", \"mission-doc\"]"
cache-key: cfs-doc-${{ github.run_number }}
deploy: false
deploy-documentation:
needs: build-cfs-documentation
if: ${{ github.event_name == 'push' && contains(github.ref, 'main') }}
name: Deploy documentation to gh-pages
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/download-artifact@v4
- name: Display structure of downloaded files
run: ls -R
- name: Move pdfs to deployment directory
run: mkdir deploy; mv */*.pdf deploy
- name: Deploy to GitHub
uses: JamesIves/github-pages-deploy-action@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages
folder: deploy
single-commit: true