You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Aug 6, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+10-11Lines changed: 10 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,7 +52,7 @@ npm install --dev
52
52
See the [spec doc](https://docs.google.com/document/d/1XZOuuGmozcLQRSDitx0UWhZzJaS4opR1JVwZqDp-N4g/edit?usp=sharing) for more details.
53
53
54
54
## Branches
55
-
Development in this repository can be done via forks or branches. Currently, we support an `integration` and `master` branch, in addition to a `meta` branch. In general, the development workflow is to open pull requests against `integration`, and to promote `integration`to `master` after testing prior to a release.
55
+
Development in this repository can be done via forks or branches. Currently, we support a `master` branch and `meta` branch. In general, the development workflow is to open pull requests against `master`, and to test `master` prior to creating new tags for a release.
56
56
57
57
In general, the git workflow within this repository loosely follows https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow .
58
58
@@ -61,21 +61,20 @@ In general, the git workflow within this repository loosely follows https://www.
61
61
Changes or additions to/of makefiles and .yaml for publishing purposes should be performed against this branch.
62
62
There is no general requirement to keep `meta` up to date with `master` or `integration`.
63
63
64
-
### Integration
65
-
`integration` is treated as a running feature branch that should **always** remain up to date with `master`.
66
-
67
64
### 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`, then a contributor with push-access to `integration` should rebase `integration` with master to ensure the branches remain in sync and conflict free.
65
+
`master` is treated as a running pre-production feature branch. Changes should not go into master until properly tested for regressions in an acceptance environment. It is an expectation that hotfixes may have to occur on occasion - on such an occasion, a feature branch should be made from the commit hash of the last release tag, and not from the head of master. Master may contain changes that have yet to be fully tested for a production release.
66
+
67
+
### Release Tags
68
+
Each release tag represents a presumptive stable release - with the most recent release tag representing the current state of our production environment.
70
69
71
-
## Releasing
72
-
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).
70
+
## Release Process
71
+
docs-worker-pool contains various triggers for release to higher environments. Currently, the repository supports an integration environment (reflecting the state of the master branch) and a production environment (reflecting the state of the most recent release tag).
73
72
74
-
### Integration
75
-
- Merge a pull request or otherwise push a commit to the integration branch.
73
+
### Integration Environment
74
+
- Merge a pull request or otherwise push a commit to `master` branch.
76
75
- Verify that the deploy-integration-ec2 workflow has executed successfully.
77
76
78
-
### Production
77
+
### Production Environment
79
78
- Rebase `master` with `integration` and push the latest changes, or merge a pull request to `master` if performing a hotfix.
80
79
- If you don't have push access, open an issue or otherwise contact a contributor with administrator priveliges.
81
80
- Create release tags. We currently follow [semver](https://semver.org/) standards.
0 commit comments