GitHub Practices and Workflows
- Bridget Almas
The following workflows apply to these repositories:
application
services
collectionspace-client
cspace-public-gateway
cspace-ui.js
cspace-input.js
cspace-refname.js
cspace-layout.js
cspace-api.js
cspace-plugin-profile-*.js (multiple repositories)
cspace-plugin-ext-*.js (multiple repositories)
cspace-plugin-record-*.js (multiple repositories)
cspace-public-browser.js
Branch | Use | Direct Commits Allowed | Pull Requests Allowed |
|---|---|---|---|
main | Always contains the latest released version of the code | None | Merge from development or release-* branches |
develop | Always contains the the latest merged code for work that is actively under development | None | Merge from feature-*, bug-* or <release>-* branches |
feature-<jiraticket> | Branch for work on a new feature | Yes | As needed |
bug-<jiraticket> | Branch for work on a bug fix | Yes | Rarely needed |
release-<jiraticket> | Branch from the latest tag for the release to use to merge a bug fix (use sparingly only for critical bug fixes) | Yes | Rarely needed |
Normal Development Process for feature and bug fixes (not release hot fixes):
Branch from development to feature-<jiraticket> or bug-<jiraticket>
Commit work to branch
When ready for code review, PR from feature-<jiraticket> or bug-<jiraticket> to development
QA process
When ready for QA, tag development for QA (vX.X.X-QAYYYYMMDD)
Deploy from tag to QA environment
Normal release process
Merge development to main
Tag main for release (vX.X.X)
Normal Hotfix release process
Create branch from latest tag for release: release-<jiraticket>
Commit work to branch
When ready for code review, PR from release-<jiraticket> to main
Tag main for release (vX.X.X)
Exception Hotfix release process (fixes that don’t go into main - should be used sparingly)
Create branch from latest tag for release: release-<jiraticket>
Commit work to branch
Code review in branch
Tag branch for release (vX.X.X)