Skip to content
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.

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

RFE: Add Doxygen Github Pages #366

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Next Next commit
github: Add Github Action to generate Doxygen
Add a Doxygen Github Action and the requisite Doxygen
config file to generate Doxygen documentation.  Documentation
is only generated for the "main" branch and is available here:

	https://seccomp.github.io/libseccomp/

Signed-off-by: Tom Hromatka <[email protected]>
  • Loading branch information
drakenclimber committed Jan 24, 2022
commit 56986ba7aa32d324f168496da20eea07c65c7de8
38 changes: 38 additions & 0 deletions .github/workflows/doxygen.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
#
# Doxygen Workflow for libseccomp
#
# Copyright (c) 2022 Oracle and/or its affiliates.
# Author: Tom Hromatka <[email protected]>
#

name: "Doxygen"
on: ["push"]

jobs:
doxygen:
name: Doxygen
# Only run Doxygen against the main branch
if: github.ref_name == 'main'
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
with:
submodules: false
- name: Initialize libseccomp
uses: ./.github/actions/setup
- name: Build libseccomp
run: |
./configure
make check-build
- uses: mattnotmitt/doxygen-action@v1
with:
working-directory: "./"
doxyfile-path: "./doc/Doxygen"
- name: Deploy Doxygen
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./html
publish_branch: html
destination_dir: doxygen/${{ github.ref_name }}
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,5 @@ tags
/stamp-h1
/cov-int
/libseccomp-coverity_*.tar.gz
/html/
/latex/
Loading