-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5c3e54e
commit 95b33b7
Showing
1 changed file
with
25 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,32 @@ | ||
# This is a basic workflow to help you get started with Actions | ||
name: Doxygen | ||
|
||
name: Doxygen Action | ||
|
||
# Controls when the action will run. Triggers the workflow on push or pull request | ||
# events but only for the master branch | ||
on: | ||
workflow_dispatch: | ||
push: | ||
branches: | ||
- main | ||
# A workflow run is made up of one or more jobs that can run sequentially or in parallel | ||
- gh-pages | ||
|
||
# In that case do the job 'make_and_deploy_doxygen' | ||
jobs: | ||
# This workflow contains a single job called "build" | ||
build: | ||
# The type of runner that the job will run on | ||
make_and_deploy_doxygen: | ||
runs-on: ubuntu-latest | ||
|
||
# Steps represent a sequence of tasks that will be executed as part of the job | ||
# which needs the following steps to be executed: | ||
steps: | ||
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it | ||
- uses: actions/checkout@v2 | ||
|
||
- name: Doxygen Action | ||
uses: mattnotmitt/doxygen-action@v1.1.0 | ||
with: | ||
# Path to Doxyfile | ||
doxyfile-path: "./Doxyfile" # default is ./Doxyfile | ||
# Working directory | ||
working-directory: "." # default is . | ||
|
||
- name: Deploy | ||
uses: peaceiris/actions-gh-pages@v3 | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
# Default Doxyfile build documentation to html directory. | ||
# Change the directory if changes in Doxyfile | ||
publish_dir: ./docs/html | ||
# 1. Checkout current branch of GitHub repository. | ||
- name: Checkout current branch | ||
uses: actions/checkout@v2 | ||
# 2. Install doxygen and its auxiliary components. | ||
- name: Install doxygen and latex components | ||
run: sudo apt-get update; sudo apt-get install -y doxygen graphviz texlive-full | ||
# 3. Create the doxygen pages. | ||
- name: Create the doxygen | ||
run: | | ||
git clone git@github.com:ritukeshbharali/falcon.git | ||
doxygen ./Doxyfile | ||
# Deploy to GitHub Pages | ||
- name: Deploy | ||
uses: peaceiris/actions-gh-pages@v3 | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
publish_dir: ./docs |