Skip to content

Commit

Permalink
docs: update git-branching.md
Browse files Browse the repository at this point in the history
Signed-off-by: John DeAngelis <[email protected]>
  • Loading branch information
johndeange committed Nov 6, 2024
1 parent 23a1792 commit daa4b03
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 60 deletions.
43 changes: 43 additions & 0 deletions docs/git-branching-and-releasing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# OPRE-OPS Branching Strategy

The OPRE Team currently uses the following branching strategy:
### main
* `main` is the default and primary branch. This will always be the most up-to-date released code base.
* `main` currently has branch protections in place, and requires a `pull request` with at least `2` approvals from someone on the `dev team`.

### Feature Branches
* Features should branch from `main` and utilize a naming format of `OPS-{Issue#}/{Feature_Name}`, example: `OPS-522/CAN_Details_Page`.

```mermaid
---
title: OPRE-OPS Git Branching
---
%%{init: {'gitGraph': {'showBranches': true, 'showCommitLabel':true,'mainBranchOrder': 4}} }%%
gitGraph
commit id: "initial commit"
commit
branch OPS-5xx/New_Feature_A
checkout OPS-5xx/New_Feature_A
commit
commit
checkout main
merge OPS-5xx/New_Feature_A
checkout main
commit
branch OPS-6xx/New_Feature_B
checkout OPS-6xx/New_Feature_B
commit
commit
commit
checkout main
merge OPS-6xx/New_Feature_B
```

# OPRE-OPS Release Strategy

The OPRE Team currently uses the following release strategy:

- When a PR is merged to `main` the GitHub Action `release.yml` will automatically create a new release in
GitHub with next version number.
- The `main` branch will be tagged with the new version number.
- The release will be published to the [GitHub Releases page](https://github.com/HHS/OPRE-OPS/releases).
60 changes: 0 additions & 60 deletions docs/git-branching.md

This file was deleted.

0 comments on commit daa4b03

Please sign in to comment.