Skip to content

Commit 7cce245

Browse files
authored
feat: Enable doxygen version to be configured (#30)
1 parent c9920d3 commit 7cce245

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ jobs:
3030
- `folder` (optional): Folder where the docs are built. Defaults to `docs/html`.
3131
- `config_file` (optional): Path of the Doxygen configuration file. Defaults to `Doxyfile`.
3232
- `target_folder` (optional): Directory within the deployment branch to push to. Defaults to empty (root).
33+
- `doxygen_version` (optional): Version of Doxygen to install. Defaults to `1.9.6`. **NOTE - only works with 1.9.3 and higher versions**
3334

3435
## Advanced Usage
3536

@@ -54,6 +55,7 @@ jobs:
5455
branch: gh-pages
5556
folder: docs/html
5657
config_file: Doxyfile
58+
doxygen_version: 1.9.6
5759
```
5860

5961
## About this Action

action.yml

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ inputs:
2424
target_folder:
2525
description: 'Directory on the deployment branch for pushing the build files'
2626
required: false
27+
doxygen_version:
28+
description: 'Version of Doxygen to install'
29+
required: false
30+
default: "1.9.6"
2731

2832
runs:
2933
using: "composite"
@@ -33,8 +37,16 @@ runs:
3337
with:
3438
submodules: "true"
3539

36-
- name: Install Doxygen
37-
run: sudo apt-get install doxygen graphviz -y
40+
- name: Install dependencies
41+
run: sudo apt-get update && sudo apt-get install -y wget graphviz
42+
shell: bash
43+
44+
- name: Install Doxygen v${{ inputs.doxygen_version }}
45+
run: |
46+
transformed_version=$(echo "${{ inputs.doxygen_version }}" | tr '.' '_')
47+
wget https://github.com/doxygen/doxygen/releases/download/Release_${transformed_version}/doxygen-${{ inputs.doxygen_version }}.linux.bin.tar.gz
48+
tar -xzf doxygen-${{ inputs.doxygen_version }}.linux.bin.tar.gz
49+
sudo mv doxygen-${{ inputs.doxygen_version }}/bin/doxygen /usr/local/bin/doxygen
3850
shell: bash
3951

4052
- name: Generate Doxygen Documentation

0 commit comments

Comments
 (0)