Skip to content

chore: adopt git-flow with a develop branch - #141

Merged
Seungpyo1007 merged 1 commit into
developfrom
chore/git-flow-develop
Aug 3, 2026
Merged

chore: adopt git-flow with a develop branch#141
Seungpyo1007 merged 1 commit into
developfrom
chore/git-flow-develop

Conversation

@Seungpyo1007

Copy link
Copy Markdown
Member

Why

Every change has been landing straight on main — and main is also the branch that publishes the site (deploy-pages) and tells TechEngine to pick up new data (notify-engine). So every merge was effectively a release, with no integration buffer.

This adds develop as the integration branch and leaves main for released state. (develop has been created from main; this PR targets it.)

Branch Role
main Released. Publishes the site + notifies the engine, so it only moves through a release PR.
develop Integration. All work branches target this.
feat/*, data/*, fix/*, chore/* Short-lived, cut from develop.

Changes

  • validate-data now runs on pushes to develop as well, so integration gets the same checking main does.
  • bump-engine lands the submodule bump on develop instead of pushing to main. It switches branch before updating the submodule — doing it after would commit on main's checkout and then orphan that commit when moving to develop.
  • README documents the model and tells contributors to target develop.

deploy-pages and notify-engine deliberately stay on main. Publishing 1.1M files and handing the engine a new data pointer are release actions; firing them on every integration merge is what we're moving away from.

Follow-ups (not in this PR)

  • Retarget TechEngine's verify-network promotion PRs from main to develop — separate repo, separate PR.
  • Optionally flip the repo's default branch to develop so new PRs default correctly.
  • 14 branches whose PRs are already merged are still on the remote and can be pruned.

Both workflow files parse as valid YAML.

Every change has been landing straight on main, which is also the branch that
publishes the site and tells TechEngine to pick up new data — so any merge was
effectively a release. Adds develop as the integration branch and keeps main for
released state.

- validate-data now also runs on pushes to develop, so integration is checked
  the same way main is
- bump-engine lands the submodule bump on develop instead of pushing to main.
  It switches branch *before* updating the submodule, so the change is staged on
  the branch that will carry it rather than being committed and then orphaned
- README documents the model and points contributors at develop

deploy-pages and notify-engine deliberately stay on main: publishing and the
engine handshake should happen on release, not on every integration merge.
@github-actions github-actions Bot added ci CI and workflow changes documentation Improvements or additions to documentation labels Jul 31, 2026
@Seungpyo1007 Seungpyo1007 moved this from Todo to In Progress in TechAPI-Project Jul 31, 2026
@Seungpyo1007
Seungpyo1007 merged commit cc7e57d into develop Aug 3, 2026
1 check passed
@Seungpyo1007
Seungpyo1007 deleted the chore/git-flow-develop branch August 3, 2026 01:07
@github-project-automation github-project-automation Bot moved this from In Progress to Done in TechAPI-Project Aug 3, 2026
Seungpyo1007 added a commit to GetTechAPI/TechEngine that referenced this pull request Aug 3, 2026
TechAPI has adopted git-flow (GetTechAPI/TechAPI#141): main is the released
state that publishes the site, develop is where integration lands. The
promotion bot writes data, so it belongs on develop.

Checks out TechAPI at develop as well as targeting it — cutting the bot branch
from main would place it behind whatever is already integrated, and the
resulting PR would drag those commits along.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci CI and workflow changes documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants