Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
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
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 <tom.hromatka@oracle.com>
#

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/
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ https://github.com/seccomp/libseccomp
[![Build Status](https://github.com/seccomp/libseccomp/workflows/Continuous%20Integration/badge.svg?branch=main)](https://github.com/seccomp/libseccomp/actions)
[![Coverage Status](https://img.shields.io/coveralls/github/seccomp/libseccomp/main.svg)](https://coveralls.io/github/seccomp/libseccomp?branch=main)
[![Language grade: C/C++](https://img.shields.io/lgtm/grade/cpp/g/seccomp/libseccomp.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/seccomp/libseccomp/context:cpp)
+[![Doxygen Documentation](https://img.shields.io/badge/Documentation-Doxygen-green.svg)](https://seccomp.github.io/libseccomp/doxygen/main)

The libseccomp library provides an easy to use, platform independent, interface
to the Linux Kernel's syscall filtering mechanism. The libseccomp API is
Expand Down
Loading