feat: Add target_folder option (#21)

README.md

@@ -29,6 +29,7 @@ jobs:
 - `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`.
+- `target_folder` (optional): Directory within the deployment branch to push to. Defaults to empty (root).
 
 ## Advanced Usage
 
@@ -65,10 +66,10 @@ The [actions/checkout](https://github.com/actions/checkout) step is used to chec
 
 ### 2. Install Doxygen
 
-Doxygen is installed by running the following command:
+Doxygen and Graphviz are installed by running the following command:
 
 ```bash
-sudo apt-get install doxygen -y
+sudo apt-get install doxygen graphviz -y
 ```
 
 ### 3. Generate Doxygen Documentation
@@ -99,6 +100,8 @@ The `folder` option determines which folder to deploy. By default, it is `docs/h
 
 The `branch` option determines which branch to deploy to. By default, it is `gh-pages`.
 
+The `target_folder` option determines which directory in the deployment branch to push to. By default, the root of the branch is overwritten.
+
 ## License
 
 This work is under an [MIT license](LICENSE)

action.yml

@@ -21,6 +21,9 @@ inputs:
     description: 'Path of the Doxygen configuration file'
     required: true
     default: "Doxyfile"
+  target_folder:
+    description: 'Directory on the deployment branch for pushing the build files'
+    required: false
 
 runs:
   using: "composite"
@@ -48,3 +51,4 @@ runs:
         token: ${{ inputs.github_token }}
         branch: ${{ inputs.branch }}
         folder: ${{ inputs.folder }}
+        target-folder: ${{ inputs.target_folder }}