Skip to content

Commit

Permalink
Add note about working directory
Browse files Browse the repository at this point in the history
  • Loading branch information
mattnotmitt committed Jan 25, 2025
1 parent 6627c43 commit ded75d9
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ An `edge` tag has been created, tracking the version of doxygen available on the

**Optional** Path of the working directory to change to before running doxygen. Default: `.`

> [!NOTE]
> If you want to use a fully qualified path, note that `${{ github.workspace }} / $GITHUB_WORKSPACE` directory
> is mounted at `/github/workspace` within the Docker container.
> See the [GitHub actions docs](https://docs.github.com/en/actions/sharing-automations/creating-actions/creating-a-docker-container-action#accessing-files-created-by-a-container-action) for more information.
### 'doxyfile-path'

**Optional** Path of the Doxyfile relative to the working directory. Default: `./Doxyfile`.
Expand Down

0 comments on commit ded75d9

Please sign in to comment.