Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update git flow convention in documentation #527

Merged
merged 7 commits into from
Dec 7, 2024

Conversation

mreeve-snl
Copy link
Collaborator

@mreeve-snl mreeve-snl commented Dec 3, 2024

🗣 Description

Adds new branching convention to releases/contributing docs.

💭 Motivation and context

We have 2 main branches whose names will stay constant:

  1. The main branch tracks Major/Minor/Patch releases only, and is only updated with merges from the develop or a hotfix branch. Releases are tagged appropriate SEMVERs based on their content: vX.Y.Z.
  2. The develop branch is our working copy of latest changes, and tracks all feature development. Feature branches are merged into develop as features are added, and when ready develop will merge into main as documented above.

There are 2 other branch naming conventions that change based on the issue/update/content they add to the project.

  1. A hotfix branch is created to "fix" or "patch" a critical issue in the main branch of the LME repository. Hotfixes are branched from main and merged into develop. This way main can get fixes, and develop will be synced with main.
    - It uses the convention: hotfix-<username>-<issue#>-<shortstring>
    - An example: hotfix-cbaxley-222-fix-the-pipeline
  2. A feature branch is created from develop to add content for issues/work/updates/etc...
    - It uses the convention: -<issue #>-shortstring
    - An example: mreeve-22-filter-events

NOTE: Each branch name will have a short string to describe what it is solving for example create-new-container:

📷 Screenshots (DELETE IF UNAPPLICABLE)

🧪 Testing

Displays properly on github wiki.

✅ Pre-approval checklist

  • Changes are limited to a single goal AND
    the title reflects this in a clear human readable format
  • Issue that this PR solves has been selected in the Development section
  • I have read and agree to LME's CONTRIBUTING.md document.
  • The PR adheres to LME's requirements in RELEASES.md
  • These code changes follow cisagov code standards.
  • All relevant repo and/or project documentation has been updated to reflect the changes in this PR.

✅ Pre-merge Checklist

  • All tests pass
  • PR has been tested and the documentation for testing is above
  • Squash and merge all commits into one PR level commit

✅ Post-merge Checklist

  • Delete the branch to keep down number of branches

@mreeve-snl mreeve-snl changed the title Hotfix mreeve 523 Update git flow convention in documentation Dec 3, 2024
@mreeve-snl mreeve-snl self-assigned this Dec 3, 2024
Copy link
Collaborator

@mitchelbaker-cisa mitchelbaker-cisa left a comment

Choose a reason for hiding this comment

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

Overall looks good. Added a couple links to RELEASES/CONTRIBUTING docs and had some questions on how we want to handle hotfixes.

CONTRIBUTING.md Outdated Show resolved Hide resolved
RELEASES.md Outdated Show resolved Hide resolved
RELEASES.md Outdated Show resolved Hide resolved
RELEASES.md Outdated Show resolved Hide resolved
RELEASES.md Show resolved Hide resolved
Copy link

@Roger-CISA Roger-CISA left a comment

Choose a reason for hiding this comment

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

Thanks Mikey and Mitchel, no edits from me.

mreeve-snl and others added 2 commits December 5, 2024 13:48
fixes links and edits

Co-authored-by: mitchelbaker-cisa <[email protected]>
OK @mitchelbaker-cisa  I think all your comments are covered in the new changes I'm pushing... let me know, and I'll let you or roger go ahead and merge this
@mreeve-snl
Copy link
Collaborator Author

mreeve-snl commented Dec 5, 2024

https://github.com/cisagov/LME/blob/hotfix-mreeve-523/RELEASES.md

OK @mitchelbaker-cisa I think all your comments are covered in the new changes I'm pushing... let me know, and I'll let you or roger go ahead and merge this

it also looks like the linux test is still having issues, but hopefully we can get that fixed up soon :)

@mitchelbaker-cisa
Copy link
Collaborator

Thanks Mikey! Now that I'm thinking about it, we could automate the post merge step if we wanted to.. maybe something we can add to our pipeline later on.

https://stackoverflow.com/questions/67668006/how-to-automatically-merge-a-branch-into-another-in-github
https://github.com/marketplace/actions/action-automerge

@mitchelbaker-cisa mitchelbaker-cisa merged commit c9c0288 into main Dec 7, 2024
4 checks passed
@mitchelbaker-cisa mitchelbaker-cisa deleted the hotfix-mreeve-523 branch December 7, 2024 00:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

update contributing.md and releases.md to reflect new commit/branch/release workflow
3 participants