From 08f91303bbba06028f11779ee8588721b294f861 Mon Sep 17 00:00:00 2001 From: Jonah Lawrence Date: Mon, 6 Dec 2021 06:58:03 +0200 Subject: [PATCH 1/4] feat: Added icon and color --- action.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/action.yml b/action.yml index ad773bc0..6a985ed7 100644 --- a/action.yml +++ b/action.yml @@ -1,6 +1,8 @@ name: 'Doxygen GitHub Pages Deploy Action' - description: 'Make docs with Doxygen then deploy the generated HTML to GitHub pages' +branding: + icon: "upload-cloud" + color: "purple" inputs: github_token: From 0133d8853710a98bdf782255b73ea9040a514491 Mon Sep 17 00:00:00 2001 From: Jonah Lawrence Date: Mon, 6 Dec 2021 06:59:35 +0200 Subject: [PATCH 2/4] feat: Added author --- action.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/action.yml b/action.yml index 6a985ed7..d0a65efe 100644 --- a/action.yml +++ b/action.yml @@ -1,4 +1,5 @@ name: 'Doxygen GitHub Pages Deploy Action' +author: 'Jonah Lawrence' description: 'Make docs with Doxygen then deploy the generated HTML to GitHub pages' branding: icon: "upload-cloud" From 768919b4d773864d43fc765527ee9bd03d1cee23 Mon Sep 17 00:00:00 2001 From: Jonah Lawrence Date: Sat, 30 Apr 2022 22:02:56 -0600 Subject: [PATCH 3/4] feat: Add option to specify config file path (#11) * feat: Add option to specify config file path * docs: Update docs to include config_file * docs: Change text to say filename --- README.md | 8 ++++++-- action.yml | 6 +++++- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 240734e6..75074634 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,7 @@ jobs: - `github_token` (required): GitHub token for pushing to repo. See the [docs](https://git.io/passing-token) for more info. - `branch` (optional): Branch to deploy to. Defaults to `gh-pages`. - `folder` (optional): Folder where the docs are built. Defaults to `docs/html`. +- `config_file` (optional): Path of the Doxygen configuration file. Defaults to `Doxyfile`. ## Advanced Usage @@ -51,6 +52,7 @@ jobs: github_token: ${{ secrets.GITHUB_TOKEN }} branch: gh-pages folder: docs/html + config_file: Doxyfile ``` ## About this Action @@ -71,10 +73,12 @@ sudo apt-get install doxygen -y ### 3. Generate Doxygen Documentation -Doxygen documentation is generated by running the following command: +Doxygen documentation is generated by running the following command. + +Set the `config_file` input option to change `Doxyfile` to a different filename. ```bash -doxygen +doxygen Doxyfile ``` ### 4. Create .nojekyll diff --git a/action.yml b/action.yml index d0a65efe..87edef84 100644 --- a/action.yml +++ b/action.yml @@ -17,6 +17,10 @@ inputs: description: 'Folder where Doxygen will generate the HTML build files' required: true default: "docs/html" + config_file: + description: 'Path of the Doxygen configuration file' + required: true + default: "Doxyfile" runs: using: "composite" @@ -31,7 +35,7 @@ runs: shell: bash - name: Generate Doxygen Documentation - run: doxygen + run: doxygen ${{ inputs.config_file }} shell: bash - name: Create .nojekyll (ensures pages with underscores work on gh pages) From f1a31f55f226a53e48f414a3aa45ede1d2fdf969 Mon Sep 17 00:00:00 2001 From: Jonah Lawrence Date: Sat, 30 Apr 2022 22:06:30 -0600 Subject: [PATCH 4/4] chore: Bump version --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 75074634..1d026a15 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ jobs: deploy: runs-on: ubuntu-latest steps: - - uses: DenverCoder1/doxygen-github-pages-action@v1 + - uses: DenverCoder1/doxygen-github-pages-action@v1.1.0 with: github_token: ${{ secrets.GITHUB_TOKEN }} ``` @@ -47,7 +47,7 @@ jobs: deploy: runs-on: ubuntu-latest steps: - - uses: DenverCoder1/doxygen-github-pages-action@v1 + - uses: DenverCoder1/doxygen-github-pages-action@v1.1.0 with: github_token: ${{ secrets.GITHUB_TOKEN }} branch: gh-pages