Skip to content

Commit

Permalink
ci: merge API Extractor / Documenter into 1 job (#710)
Browse files Browse the repository at this point in the history
  • Loading branch information
davidlj95 authored Jul 22, 2024
1 parent 0b130a0 commit 1c71094
Showing 1 changed file with 2 additions and 25 deletions.
27 changes: 2 additions & 25 deletions .github/workflows/reusable-api-extractor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,12 @@ on:
env:
# 👇 Keep in sync with build workflow
TSC_ARTIFACT_NAME_SUFFIX: -tsc
API_EXTRACTOR_ARTIFACT_NAME_SUFFIX: -api-extractor
# 👇 Keep in sync with docs workflow
API_DOCS_ARTIFACT_NAME_SUFFIX: -api-docs

jobs:
api-extractor:
name: API Extractor (report and JSON docs)
name: API Extractor
runs-on: ubuntu-latest
timeout-minutes: 5
steps:
Expand All @@ -26,31 +25,9 @@ jobs:
uses: ./.github/actions/setup
- name: Run API Extractor in production mode
run: cd .ci && make api-extractor
- name: Upload API Extractor JSON docs
uses: actions/upload-artifact@0b2256b8c012f0828dc542b3febcab082c67f72b # v4
with:
name: ngx-meta${{ env.API_EXTRACTOR_ARTIFACT_NAME_SUFFIX }}
path: projects/ngx-meta/api-extractor/*.api.json
retention-days: 5

api-documenter:
needs: api-extractor
name: API Documenter (markdown API Ref docs)
runs-on: ubuntu-latest
timeout-minutes: 5
steps:
- name: Checkout
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
- name: Download API Extractor JSON docs
uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4
with:
name: ngx-meta${{ env.API_EXTRACTOR_ARTIFACT_NAME_SUFFIX }}
path: projects/ngx-meta/api-extractor
- name: Setup
uses: ./.github/actions/setup
- name: Run API Documenter
run: cd .ci && make api-documenter
- name: Upload API Documenter generated markdown docs
- name: Upload API Documenter generated Markdown docs
uses: actions/upload-artifact@0b2256b8c012f0828dc542b3febcab082c67f72b # v4
with:
name: ngx-meta${{ env.API_DOCS_ARTIFACT_NAME_SUFFIX }}
Expand Down

0 comments on commit 1c71094

Please sign in to comment.