Skip to content

Conversation

@ben-edna
Copy link
Contributor

@ben-edna ben-edna commented Jan 8, 2026

Summary by CodeRabbit

  • Chores
    • Updated the documentation/landing-page publishing workflow: replaced the publishing action and revised the publish configuration and authentication inputs to change how builds are deployed to the Pages repository.

✏️ Tip: You can customize this high-level summary in your review settings.

@ben-edna ben-edna added documentation Improvements or additions to documentation development Tools for development labels Jan 8, 2026
@coderabbitai
Copy link

coderabbitai bot commented Jan 8, 2026

Walkthrough

Replaced the GitHub Actions deploy step in the landing-page workflow: switched tsunematsu21/actions-publish-gh-pages@... to peaceiris/actions-gh-pages@... and updated action inputs from dir, repo, branch, token to publish_dir, external_repository, publish_branch, deploy_key.

Changes

Cohort / File(s) Summary
GitHub Actions Workflow Configuration
.github/workflows/docs.yml
Replaced publish action from tsunematsu21/actions-publish-gh-pages@... to peaceiris/actions-gh-pages@...; renamed inputs dirpublish_dir, repoexternal_repository, branchpublish_branch, tokendeploy_key (adjusted publishing/auth configuration).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Fix landing page workflow' is generic and does not clearly describe the specific change: upgrading the GitHub Pages publish action and updating configuration parameters. Consider a more specific title like 'Upgrade landing page publishing action from tsunematsu21 to peaceiris' to better convey the actual change made.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between eb582bd and 8a5c3c9.

📒 Files selected for processing (1)
  • .github/workflows/docs.yml
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/docs.yml
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (18)
  • GitHub Check: Publish Python distribution 📦 to TestPyPI
  • GitHub Check: build / build (ubuntu-latest)
  • GitHub Check: build / build (windows-latest)
  • GitHub Check: build / build (macos-latest)
  • GitHub Check: Codacy Static Code Analysis
  • GitHub Check: DevContainer Build & Test
  • GitHub Check: run / run (macos-latest, 3.14)
  • GitHub Check: run / run (windows-latest, 3.12)
  • GitHub Check: run / run (windows-latest, 3.11)
  • GitHub Check: run / run (windows-latest, 3.14)
  • GitHub Check: run / run (windows-latest, 3.13)
  • GitHub Check: run / run (windows-latest, 3.9)
  • GitHub Check: run / run (macos-latest, 3.10)
  • GitHub Check: run / run (windows-latest, 3.10)
  • GitHub Check: run / run (macos-latest, 3.13)
  • GitHub Check: run / run (macos-latest, 3.12)
  • GitHub Check: test / test
  • GitHub Check: run / test-cygwin

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In @.github/workflows/docs.yml:
- Around line 37-38: Remove the unnecessary permissions entry by deleting the
"contents: write" line from the permissions block (the permissions: / contents:
write setting) so the workflow no longer grants write access to GITHUB_TOKEN;
rely on the custom GH_DFETCH_ORG_DEPLOY token for publishing and ensure the
permissions block only includes the minimal scopes required (or remove the block
entirely if not needed).
📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b9f4239 and eb582bd.

📒 Files selected for processing (1)
  • .github/workflows/docs.yml
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-12-25T23:53:05.742Z
Learnt from: spoorcc
Repo: dfetch-org/dfetch PR: 861
File: .github/workflows/build.yml:120-125
Timestamp: 2025-12-25T23:53:05.742Z
Learning: When building macOS PKG installers with fpm in CI, account for the known issue (fpm #1996) where --prefix can be duplicated (e.g., /opt/dfetch becomes /opt/dfetch/opt/dfetch). In the workflow at .github/workflows/build.yml, verify install paths and PATH entries do not assume a single-prefix layout. Adjust packaging scripts or fpm arguments to normalize the final install location and update PATH references accordingly. Add a test step to validate the expected runtime paths after installation.

Applied to files:

  • .github/workflows/docs.yml
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Codacy Static Code Analysis
  • GitHub Check: DevContainer Build & Test

@ben-edna ben-edna force-pushed the fix-landing-page-deploy branch from eb582bd to 8a5c3c9 Compare January 9, 2026 16:07
@ben-edna ben-edna changed the title Add permissions for landing page workflow Fix landing page workflow Jan 9, 2026
@ben-edna ben-edna merged commit 5780cec into main Jan 9, 2026
38 checks passed
@ben-edna ben-edna deleted the fix-landing-page-deploy branch January 9, 2026 16:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

development Tools for development documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants