Skip to content

Migrate GitHub Pages to modern Actions-based deployment#321

Open
rgregg-msft wants to merge 1 commit intomasterfrom
migrate-github-pages
Open

Migrate GitHub Pages to modern Actions-based deployment#321
rgregg-msft wants to merge 1 commit intomasterfrom
migrate-github-pages

Conversation

@rgregg-msft
Copy link
Contributor

Summary

  • Replaces the classic "Deploy from branch" Pages setup with a GitHub Actions workflow
  • Uses the modern configure-pagesjekyll-build-pagesupload-pages-artifactdeploy-pages action stack
  • Moves CNAME into the docs/ source directory so the custom domain (apidoctor.md) is preserved in the built site

Post-merge manual step

In the repo Settings → Pages, change the source from "Deploy from a branch" to "GitHub Actions" to complete the migration.

Test plan

  • PR workflow runs green
  • After merge, confirm the Deploy GitHub Pages workflow triggers and completes successfully
  • Verify the site is live at the custom domain after switching the Pages source setting to GitHub Actions

🤖 Generated with Claude Code

Replace classic branch-based publishing with a GitHub Actions workflow
using configure-pages, jekyll-build-pages, upload-pages-artifact, and
deploy-pages. Also moves CNAME into the docs/ source directory.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings March 17, 2026 19:34
@rgregg-msft
Copy link
Contributor Author

Post-merge action required

After this PR is merged, go to Settings → Pages and change the source from "Deploy from a branch" to "GitHub Actions".

This is the final step to complete the migration — the new workflow won't be used until that setting is switched.

Copy link
Contributor

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

Migrates the repository’s GitHub Pages publishing from the legacy “deploy from branch” model to the modern GitHub Actions–based Pages deployment pipeline, while ensuring the custom domain is included in the built site output.

Changes:

  • Added a GitHub Actions workflow to build the site from ./docs using the official Pages action stack and deploy it to GitHub Pages.
  • Added docs/CNAME so the custom domain (apidoctor.md) is preserved as part of the Pages build output.

Reviewed changes

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

File Description
docs/CNAME Adds custom domain configuration into the Pages source directory so it’s emitted into the deployed artifact.
.github/workflows/pages.yml Introduces an Actions-based build + deploy workflow using configure-pagesjekyll-build-pagesupload-pages-artifactdeploy-pages.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@@ -0,0 +1 @@
apidoctor.md No newline at end of file
destination: ./_site

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
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.

2 participants