Skip to content

Introduce coverage generation skip input #183

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

Draft
Orkuncakilkaya wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Introduce coverage generation skip input #183

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
30 changes: 17 additions & 13 deletions .github/workflows/docs-and-coverage.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,16 @@ on:
type: string
required: false
description: Commands to run after installing dependencies.
prepare-gh-pages-commands:
required: false
default: |
mv docs ./gh-pages
mv coverage/lcov-report ./gh-pages/coverage
type: string
description: >
Commands to prepare the content of the gh-pages folder. The gh-pages folder will be created automatically.
Only specify the commands for moving files into it.
skip-docs-step:
required: false
default: false
type: boolean
description: 'Skip the documentation generation step.'
skip-coverage-step:
required: false
default: false
type: boolean
description: 'Skip the coverage report generation step.'

jobs:
generate-docs-and-coverage:
Expand Down Expand Up @@ -69,18 +65,26 @@ jobs:
run: $PACKAGE_MANAGER run docs

- name: Collect coverage report
if: ${{ inputs.skip-coverage-step != true }}
run: $PACKAGE_MANAGER test:coverage

- name: Create Coverage Badges
if: ${{ inputs.skip-coverage-step != true }}
uses: jaywcjlove/coverage-badges-cli@998665f7962b1a3935ba8c3e786171a99436e5d1 # v2.3.0
with:
source: coverage/coverage-summary.json
output: coverage/lcov-report/badges.svg

- name: Prepare folder for gh-pages
run: |
mkdir gh-pages
${{ inputs.prepare-gh-pages-commands }}
- name: Prepare gh-pages folder
run: mkdir gh-pages

- name: Move docs to the gh-pages folder
if: ${{ inputs.skip-docs-step != true }}
run: mv docs ./gh-pages

- name: Move coverage report to the gh-pages folder
if: ${{ inputs.skip-coverage-step != true }}
run: mv coverage/lcov-report ./gh-pages/coverage

- name: Deploy 🚀
uses: JamesIves/github-pages-deploy-action@d92aa235d04922e8f08b40ce78cc5442fcfbfa2f # v4.8.0
Expand Down
Loading