Skip to content

Commit

Permalink
Further README.md updates for process clarifications
Browse files Browse the repository at this point in the history
  • Loading branch information
casthewiz authored and Cassidy Schaufele committed May 14, 2021
1 parent 30a7250 commit 5a39aff
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,16 +57,16 @@ Development in this repository can be done via forks or branches. Currently, we
In general, the git workflow within this repository loosely follows https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow .

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

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

### Master
`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.
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.
`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.
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.

## Releasing
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).
Expand All @@ -76,6 +76,7 @@ docs-worker-pool contains various triggers for release to higher environments. C
- Verify that the deploy-integration-ec2 workflow has executed successfully.

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

0 comments on commit 5a39aff

Please sign in to comment.