Skip to content

Conversation

@2bndy5
Copy link
Contributor

@2bndy5 2bndy5 commented Sep 7, 2025

  • uses actions/deploy-pages (for better provenance)
  • uses a separate conditional job to deploy docs (for a clean env with limited attack surface)
  • uses action/upload-pages-artifact (for preparing artifact in expected format)
  • an input option with a default value is not a required input

@2bndy5 2bndy5 requested a review from Copilot September 7, 2025 15:43
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR refactors the documentation deployment workflows to use a separate deployment job with GitHub's official deployment action for improved security and provenance.

  • Splits build and deployment into separate jobs for better security isolation
  • Replaces custom deployment actions with the official actions/deploy-pages action
  • Adds proper GitHub Pages permissions and environment configuration

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
.github/workflows/sphinx.yml Separates Sphinx docs build from deployment, uses official deploy-pages action
.github/workflows/mkdocs.yml Separates MkDocs build from deployment, removes git configuration and uses official deploy-pages action

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@2bndy5 2bndy5 force-pushed the gh-pages-deployment branch from fe8b285 to ea52ebb Compare September 7, 2025 18:49
@2bndy5
Copy link
Contributor Author

2bndy5 commented Sep 7, 2025

going to try to test this in cpp-linter-action and clang-tools-pip first

- uses actions/deploy-pages (for better provenance)
- uses a separate conditional job to deploy docs (for a clean env with limited attack surface)
- uses action/upload-pages-artifact (for preparing artifact in expected format)
- an input option with a default value is not required
@2bndy5 2bndy5 force-pushed the gh-pages-deployment branch from 6cc2564 to 608dfd0 Compare September 7, 2025 19:45
@2bndy5
Copy link
Contributor Author

2bndy5 commented Sep 7, 2025

this works in

  • cpp-linter-action
  • cpp-linter
  • clang-tools-pip

@2bndy5 2bndy5 merged commit 9820dbf into main Sep 7, 2025
4 checks passed
@2bndy5 2bndy5 deleted the gh-pages-deployment branch September 7, 2025 19:48
2bndy5 added a commit to cpp-linter/cpp-linter that referenced this pull request Sep 7, 2025
now that it uses uv in reusable workflow

see also cpp-linter/.github#52
2bndy5 added a commit to cpp-linter/cpp-linter that referenced this pull request Sep 7, 2025
now that it uses uv in reusable workflow

see also cpp-linter/.github#52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants