Skip to content

Refactor GitHub Actions for GitHub Pages deployment#319

Merged
mattleibow merged 3 commits into
mainfrom
mattleibow-patch-1
Oct 13, 2025
Merged

Refactor GitHub Actions for GitHub Pages deployment#319
mattleibow merged 3 commits into
mainfrom
mattleibow-patch-1

Conversation

@mattleibow

Copy link
Copy Markdown
Collaborator

This pull request updates the GitHub Actions workflow for documentation deployment, modernizing the process and improving security and reliability. The workflow now uses updated actions, sets explicit permissions for the GitHub token, and streamlines deployment to GitHub Pages.

Workflow modernization and deployment improvements:

  • Updated the workflow to use newer versions of actions, including actions/checkout@v3 and actions/setup-dotnet@v3, and replaced the deprecated peaceiris/actions-gh-pages with actions/deploy-pages@v4 for GitHub Pages deployment.
  • Added explicit permissions for the GitHub token to restrict access and enhance security during deployment (actions: read, pages: write, id-token: write).
  • Introduced concurrency control to ensure only one deployment runs at a time, preventing overlapping deployments but allowing in-progress runs to finish.
  • Changed the job name from deploy to publish-docs and set up the deployment environment for GitHub Pages, including the deployment URL output.
  • Updated the steps to install .NET 8.x, update the docfx tool, build documentation, upload the artifact, and deploy to GitHub Pages using the latest recommended approach.

Updated GitHub Actions workflow to improve deployment process for GitHub Pages, including .NET setup and artifact upload.
@mattleibow mattleibow merged commit e1d8207 into main Oct 13, 2025
2 of 6 checks passed
@mattleibow mattleibow deleted the mattleibow-patch-1 branch October 13, 2025 21:42
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.

1 participant