Skip to content

docs: define release branch workflow#35

Merged
wauputr4 merged 1 commit into
mainfrom
codex/release-workflow
Jul 20, 2026
Merged

docs: define release branch workflow#35
wauputr4 merged 1 commit into
mainfrom
codex/release-workflow

Conversation

@wauputr4

@wauputr4 wauputr4 commented Jul 20, 2026

Copy link
Copy Markdown
Member

Summary

  • direct all contribution pull requests to main
  • reserve release for organization-managed Cloudflare production promotion
  • document the required main to release pull request flow

Validation

  • npm run build (105 pages, 0 errors)

Summary by CodeRabbit

  • Documentation
    • Clarified contribution guidelines, including the correct branch for pull requests and the production release process.
    • Updated deployment instructions with current hosting details, build output, custom domain, and base path information.
    • Removed outdated guidance about manually enabling and running deployment workflows.

@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 8d4b197d-4f1b-418d-bf8c-9c3dd8deb37d

📥 Commits

Reviewing files that changed from the base of the PR and between 2d3ac61 and 86a7cf1.

📒 Files selected for processing (2)
  • CONTRIBUTING.md
  • README.md

📝 Walkthrough

Walkthrough

Updated contribution and deployment documentation to direct contributions to main, reserve release for approved production promotion, and document the current GitHub Pages configuration alongside the planned Cloudflare release flow.

Changes

Contribution and deployment documentation

Layer / File(s) Summary
Branch and deployment guidance
CONTRIBUTING.md, README.md
Contribution PRs target main; approved organization members promote main to release for production. The README documents the GitHub Pages workflow, build output, domain, base path, and planned Cloudflare deployment.

Estimated code review effort: 1 (Trivial) | ~3 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/release-workflow

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.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request updates the contribution and deployment documentation in CONTRIBUTING.md and README.md to introduce a new release branch workflow for Cloudflare production deployments. The reviewer identified a potential issue where automated content syncs to the main branch will not automatically propagate to the production site on the release branch, and suggested updating the auto-sync workflow or documenting how these updates are promoted.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread README.md
Comment on lines +76 to +78
Semua kontribusi tetap masuk ke `main`. Rilis produksi dipromosikan oleh anggota
organisasi melalui pull request dari `main` ke `release`; jangan membuka pull
request kontribusi langsung ke `release`.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

There is a workflow discrepancy between the new release branch deployment model and the automated content sync.

Currently, the Auto Sync workflow (described in lines 95-107) automatically commits updated data to main and deploys it. If the production site on Cloudflare tracks the release branch, these automated updates (which run every 6 hours) will not appear on the production site until a manual pull request from main to release is created and merged.

To resolve this, consider updating the auto-sync workflow to also handle promotion to release, or document how these automated updates are expected to reach production.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 86a7cf175b

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
Comment on lines +76 to +78
Semua kontribusi tetap masuk ke `main`. Rilis produksi dipromosikan oleh anggota
organisasi melalui pull request dari `main` ke `release`; jangan membuka pull
request kontribusi langsung ke `release`.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Align release instructions with active deploy triggers

I checked the repo-defined deployment paths: .github/workflows/deploy-pages.yml still deploys GitHub Pages only on pushes to main (lines 3-6), and sync-content.yml deploys only when github.ref == 'refs/heads/main' (lines 116-123). In that current setup, following this new mainrelease promotion instruction would not trigger any deployment, while pushes to main still would, so the documented production release path contradicts the active workflows unless the deployment configuration is updated alongside it.

Useful? React with 👍 / 👎.

@wauputr4
wauputr4 merged commit adc6f70 into main Jul 20, 2026
1 of 2 checks passed
@wauputr4
wauputr4 deleted the codex/release-workflow branch July 20, 2026 07:21
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