Skip to content

Deploy docs & coverage report #283

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

Closed
rockdaboot wants to merge 1 commit into from
+68 −1
Closed

Deploy docs & coverage report #283

Show file tree
Hide file tree
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
62 changes: 62 additions & 0 deletions .github/workflows/gh-pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: Deploy Docs & Coverage

on:
push:
branches: [master]
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
coverage:
name: Generate & Deploy Coverage
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Install dependencies
run: |
sudo apt-get update
sudo apt-get install -y autoconf automake autopoint libtool gtk-doc-tools xsltproc lcov gettext

- name: Bootstrap & Configure for Docs
run: |
./autogen.sh
./configure --enable-gtk-doc

- name: Build Documentation
run: |
make -C docs/libpsl
mkdir -p public/docs
cp -r docs/libpsl/html/* public/docs/

- name: Generate Coverage Report
run: |
make -j$(nproc) check-coverage
mkdir -p public/lcov
cp -r lcov/* public/lcov/

# Generate root page
- name: Structure Pages Artifact
run: |
echo '<html><body><h1>libpsl Artifacts</h1><ul><li><a href="docs/">Dokumentation</a></li><li><a href="lcov/">Coverage Report</a></li></ul></body></html>' > public/index.html

- name: Upload Pages Artifact
uses: actions/upload-pages-artifact@v3
with:
path: public/

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,12 @@ The original DAFSA code is from the [Chromium Project](https://code.google.com/p

## API Documentation

You find the current API documentation [here](https://rockdaboot.github.io/libpsl).
You find the current API documentation [here](https://rockdaboot.github.io/libpsl/docs).


## Code Coverage

You can view the code coverage report [here](https://rockdaboot.github.io/libpsl/lcov/index.html).


## Quick API example
Expand Down
Loading