Skip to content
This repository was archived by the owner on Aug 6, 2025. It is now read-only.

Commit 5a39aff

Browse files
casthewizCassidy Schaufele
authored andcommitted
Further README.md updates for process clarifications
1 parent 30a7250 commit 5a39aff

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,16 +57,16 @@ Development in this repository can be done via forks or branches. Currently, we
5757
In general, the git workflow within this repository loosely follows https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow .
5858

5959
### Meta
60-
`Meta` contains various makefiles and .yaml files used for configuration.
60+
`meta` contains various makefiles and .yaml files used for configuration.
6161
Changes or additions to/of makefiles and .yaml for publishing purposes should be performed against this branch.
62-
There is no general requirement to keep `Meta` up to date with `Master` or `Integration`.
62+
There is no general requirement to keep `meta` up to date with `master` or `integration`.
6363

6464
### Integration
65-
`Integration` is treated as a running feature branch that should **always** remain up to date with `master`
65+
`integration` is treated as a running feature branch that should **always** remain up to date with `master`.
6666

6767
### Master
68-
`Master` is treated as our production state branch. In general, pull requests to master should be opened only from integration or a hot-fix feature branch.
69-
If a change is merged into `Master` that is not present in `Integration`, in general, that change should be merged as well from said branch or fork into integration.
68+
`master` is treated as our production state branch. In general, pull requests to master should be opened only from integration or a hot-fix feature branch.
69+
If a change is merged into `master` that is not present in `integration`, then a contributor with push-access to `integration` should rebase `integration` with master to ensure the branches remain in sync and conflict free.
7070

7171
## Releasing
7272
docs-worker-pool contains various triggers for release to higher environments. Currently, the repository supports an integration environment (reflecting the state of the integration branch) and a production environment (reflecting the state of the most recent release tag).
@@ -76,6 +76,7 @@ docs-worker-pool contains various triggers for release to higher environments. C
7676
- Verify that the deploy-integration-ec2 workflow has executed successfully.
7777

7878
### Production
79-
- Merge outstanding changes within `integration` to `master`.
80-
- Create release tags.
79+
- Rebase `master` with `integration` and push the latest changes, or merge a pull request to `master` if performing a hotfix.
80+
- If you don't have push access, open an issue or otherwise contact a contributor with administrator priveliges.
81+
- Create release tags. We currently follow [semver](https://semver.org/) standards.
8182
- Verify that the deploy-production-ec2 workflow executed successfully for both job runs across both production instances.

0 commit comments

Comments
 (0)