ci(docs): add PR docs preview workflow and enforce develop as default base branch by Copilot · Pull Request #84 · RussellSB/pytrendy

Copilot · 2026-04-04T22:07:15Z

Create .github/workflows/docs-preview.yaml for PR docs previews
Update .github/copilot-instructions.md to mandate develop as default base branch
Fix spurious pyproject.toml/CHANGELOG.md diffs by aligning branch with develop
Address review bot comments:
- Use stable hidden HTML marker  for comment lookup so deploy/cleanup jobs always find the same comment regardless of its current text
- Include the stable marker in the cleanup comment body to survive future re-deploys
- Add git pull --rebase origin gh-pages before push in cleanup to prevent non-fast-forward failures when concurrent jobs push to gh-pages

chore: synch up develop with main again

Agent-Logs-Url: https://github.com/RussellSB/pytrendy/sessions/3993dd13-fd55-4617-9e8b-0682b3c54b42 Co-authored-by: RussellSB <35470600+RussellSB@users.noreply.github.com>

RussellSB

Nitpick: is the git diff in pyproject.toml and changelog.md releveant to this PR? This might have come when the base branch was main, and I manually changed it to dev.

Investigate this, and so this doesn't happen with shenanigans, make sure that the base branch for agent PR requests is develop by default. Update the copilot skill for this

Copilot

Pull request overview

Adds a GitHub Actions workflow to build and publish per-PR documentation previews to GitHub Pages, with automated cleanup on PR close. The PR also includes a version bump and changelog entry that appear unrelated to the stated docs-preview purpose.

Changes:

Add .github/workflows/docs-preview.yaml to deploy PR-scoped MkDocs builds to gh-pages/pr-{N}/ and comment the preview URL on the PR.
Add a cleanup job to remove pr-{N}/ from gh-pages when the PR is closed.
Update pyproject.toml version and prepend a new CHANGELOG.md entry.

Reviewed changes

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

File	Description
`.github/workflows/docs-preview.yaml`	New PR docs preview + teardown workflow targeting `gh-pages/pr-{N}/` with PR commenting.
`pyproject.toml`	Bumps project version to `1.1.11`.
`CHANGELOG.md`	Adds a new `1.1.11` release section at the top.

Copilot · 2026-04-04T22:20:15Z

+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                comment_id: botComment.id,
+                body: `📚 **Docs preview removed**\n\nThe docs preview for this PR has been cleaned up.`,


Cleanup updates the PR comment body to 'Docs preview removed', which removes the 'Docs preview deployed' text used by the deploy job to locate and update the existing comment. This makes it likely that the next deploy will post a duplicate comment instead of updating the existing one. Keep the same marker text (or a hidden marker) in both the deploy and cleanup comment bodies so the comment remains discoverable.

Suggested change

body: `📚 **Docs preview removed**\n\nThe docs preview for this PR has been cleaned up.`,

body: `\n📚 **Docs preview removed**\n\nThe docs preview for this PR has been cleaned up.`,

Co-authored-by: RussellSB <35470600+RussellSB@users.noreply.github.com>

Agent-Logs-Url: https://github.com/RussellSB/pytrendy/sessions/9590c86c-ccd9-4bf9-b81f-bd57c3ce8960 Co-authored-by: RussellSB <35470600+RussellSB@users.noreply.github.com>

Copilot · 2026-04-04T22:26:27Z

Nitpick: is the git diff in pyproject.toml and changelog.md releveant to this PR? This might have come when the base branch was main, and I manually changed it to dev.

Investigate this, and so this d...

The spurious diffs were caused by the branch being forked from main at v1.1.11 rather than from develop (which is still at v1.1.10). When the PR base was manually changed to develop, those release-only changes showed up in the diff.

Fixed in commits 43e186a and 378b1bf:

pyproject.toml and CHANGELOG.md are now aligned with develop's state so the PR diff is clean.
.github/copilot-instructions.md has a new Default Base Branch section instructing Copilot to always branch off and target develop for all future PRs.

…e push in cleanup Agent-Logs-Url: https://github.com/RussellSB/pytrendy/sessions/69f331ee-6fb1-4c47-b39c-ec62bf26f807 Co-authored-by: RussellSB <35470600+RussellSB@users.noreply.github.com>

codecov · 2026-04-04T23:22:10Z

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

and enforce develop as default base branch in copilot instructions Co-authored-by: RussellSB <35470600+RussellSB@users.noreply.github.com>

and enforce develop as default base branch in copilot instructions Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>

RussellSB and others added 3 commits April 1, 2026 14:38

Merge pull request #83 from RussellSB/develop

8d3e45e

chore: synch up develop with main again

chore(release): 1.1.11 [skip ci]

9f1bd17

Initial plan

e01195c

Copilot AI assigned Copilot and RussellSB Apr 4, 2026

Copilot started work on behalf of RussellSB April 4, 2026 22:07 View session

RussellSB changed the base branch from main to develop April 4, 2026 22:07

ci(docs): add PR docs preview workflow

86608ac

Agent-Logs-Url: https://github.com/RussellSB/pytrendy/sessions/3993dd13-fd55-4617-9e8b-0682b3c54b42 Co-authored-by: RussellSB <35470600+RussellSB@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Add temporary deployment for documentation changes~~ ci(docs): add PR docs preview workflow Apr 4, 2026

Copilot AI requested a review from RussellSB April 4, 2026 22:11

Copilot finished work on behalf of RussellSB April 4, 2026 22:11

RussellSB requested a review from Copilot April 4, 2026 22:16

Copilot started reviewing on behalf of RussellSB April 4, 2026 22:17 View session

RussellSB requested changes Apr 4, 2026

View reviewed changes

Copilot started work on behalf of RussellSB April 4, 2026 22:20 View session

Copilot AI reviewed Apr 4, 2026

View reviewed changes

Copilot AI and others added 3 commits April 4, 2026 22:22

Initial plan

04a46b1

Co-authored-by: RussellSB <35470600+RussellSB@users.noreply.github.com>

docs: set develop as default base branch in copilot instructions

378b1bf

Agent-Logs-Url: https://github.com/RussellSB/pytrendy/sessions/9590c86c-ccd9-4bf9-b81f-bd57c3ce8960 Co-authored-by: RussellSB <35470600+RussellSB@users.noreply.github.com>

chore: align pyproject.toml and CHANGELOG.md with develop base branch

43e186a

Agent-Logs-Url: https://github.com/RussellSB/pytrendy/sessions/9590c86c-ccd9-4bf9-b81f-bd57c3ce8960 Co-authored-by: RussellSB <35470600+RussellSB@users.noreply.github.com>

Copilot AI changed the title ~~ci(docs): add PR docs preview workflow~~ ci(docs): add PR docs preview workflow and enforce develop as default base branch Apr 4, 2026

Copilot finished work on behalf of RussellSB April 4, 2026 22:27

Copilot AI requested a review from RussellSB April 4, 2026 22:27

Copilot started work on behalf of RussellSB April 4, 2026 22:27 View session

fix(ci): use stable HTML marker for bot comment lookup and pull befor…

0d402c5

…e push in cleanup Agent-Logs-Url: https://github.com/RussellSB/pytrendy/sessions/69f331ee-6fb1-4c47-b39c-ec62bf26f807 Co-authored-by: RussellSB <35470600+RussellSB@users.noreply.github.com>

Copilot finished work on behalf of RussellSB April 4, 2026 22:28

RussellSB approved these changes Apr 4, 2026

View reviewed changes

RussellSB marked this pull request as ready for review April 4, 2026 23:20

RussellSB merged commit c7ece33 into develop Apr 4, 2026
2 checks passed

RussellSB deleted the copilot/add-temporary-docs-deploy branch April 4, 2026 23:44

Copilot AI added a commit that referenced this pull request Apr 5, 2026

ci(docs): add PR docs preview workflow #84

911e69f

and enforce develop as default base branch in copilot instructions Co-authored-by: RussellSB <35470600+RussellSB@users.noreply.github.com>

RussellSB added a commit that referenced this pull request Apr 5, 2026

ci(docs): add PR docs preview workflow #84 (#86)

62ebbbb

and enforce develop as default base branch in copilot instructions Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ci(docs): add PR docs preview workflow and enforce develop as default base branch#84

ci(docs): add PR docs preview workflow and enforce develop as default base branch#84
RussellSB merged 8 commits intodevelopfrom
copilot/add-temporary-docs-deploy

Copilot AI commented Apr 4, 2026 •

edited

Loading

Uh oh!

RussellSB left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Apr 4, 2026

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Apr 4, 2026

Uh oh!

codecov bot commented Apr 4, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	body: `📚 Docs preview removed\n\nThe docs preview for this PR has been cleaned up.`,
	body: `<!-- Docs preview deployed -->\n📚 Docs preview removed\n\nThe docs preview for this PR has been cleaned up.`,

Conversation

Copilot AI commented Apr 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

RussellSB left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Apr 4, 2026

Uh oh!

codecov bot commented Apr 4, 2026

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Copilot AI commented Apr 4, 2026 •

edited

Loading