search

DenverCoder1 / doxygen-github-pages-action

GitHub Action for deploying Doxygen documentation to a GitHub pages branch
MIT License
75 stars 16 forks source link

Update the sample in README.md with explicit permission control. #31

Closed suikan4github closed 2 weeks ago

suikan4github commented 3 weeks ago

By adding the explicit permission declaration, the user can deploy the HTML document with the default workflow permission of their repository.

    permissions:
      contents: write
      pages: write

In issue #24, It is suggested to change the Workflow permission of the user repository setting from "Read repository contents and packages permissions" (default) to "Read and write permissions", to avoid the error at deployment by GitHub actions (See the figure below).

2024-09-25 (2)

This explicit permission declaration in this pull request has two advantages compared to the one suggested in Issue #24.

  1. The user of doxygen-github-pages-action doesn't need to change the repository workflow permission from the default ( easy to use ).
  2. The user can keep the repository workflow permission in a strict state ( global safe ).

The changed YAMLs inside README.md have been tested with my test repository. I confirmed they work fine.

DenverCoder1 commented 2 weeks ago

Looks great! Thanks for the contribution :tada:

suikan4github commented 2 weeks ago

My pleasure. Thank you for merging the PR. Have a good day!