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

Commit a1f1049

Browse files
authored
Dop 2236 (#438)
* Update deploy-production-ec2.yml * Update deploy-integration-ec2.yml * Update README.md for branch consolidation
1 parent 7245386 commit a1f1049

File tree

3 files changed

+15
-14
lines changed

3 files changed

+15
-14
lines changed

.github/workflows/deploy-integration-ec2.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
on:
22
push:
33
branches:
4-
- integration
4+
- master
55
name: Deploy Integration
66
jobs:
77
deploy-integration:
@@ -16,12 +16,12 @@ jobs:
1616
key: ${{ secrets.EC2_RSA_KEY }}
1717
known_hosts: ${{ secrets.EC2_KNOWN_HOSTS }}
1818
name: id_rsa
19-
- name: Deploy Integration to Integration
19+
- name: Deploy Master to Integration
2020
run: |
2121
ssh -l ubuntu ${{ secrets.INTEGRATION_HOST}} -T '
2222
cd docs-worker-pool
2323
git fetch origin
24-
git checkout origin/integration
24+
git checkout origin/master
2525
sudo docker system prune -af
2626
sudo docker build --no-cache --tag integration .
2727
sudo docker stop $(sudo docker ps -a -q)

.github/workflows/deploy-production-ec2.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ jobs:
2929
sudo docker stop $(sudo docker ps -a -q)
3030
sudo sh rundocker.sh
3131
sudo sh rundocker.sh
32+
sudo docker container prune -f
3233
'
3334
deploy-production-2:
3435
if: startsWith(github.ref, 'refs/tags/v')
@@ -55,5 +56,6 @@ jobs:
5556
sudo docker stop $(sudo docker ps -a -q)
5657
sudo sh rundocker.sh
5758
sudo sh rundocker.sh
59+
sudo docker container prune -f
5860
'
5961

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ npm install --dev
5252
See the [spec doc](https://docs.google.com/document/d/1XZOuuGmozcLQRSDitx0UWhZzJaS4opR1JVwZqDp-N4g/edit?usp=sharing) for more details.
5353

5454
## 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.
5656

5757
In general, the git workflow within this repository loosely follows https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow .
5858

@@ -61,21 +61,20 @@ In general, the git workflow within this repository loosely follows https://www.
6161
Changes or additions to/of makefiles and .yaml for publishing purposes should be performed against this branch.
6262
There is no general requirement to keep `meta` up to date with `master` or `integration`.
6363

64-
### Integration
65-
`integration` is treated as a running feature branch that should **always** remain up to date with `master`.
66-
6764
### 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.
7069

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).
7372

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.
7675
- Verify that the deploy-integration-ec2 workflow has executed successfully.
7776

78-
### Production
77+
### Production Environment
7978
- Rebase `master` with `integration` and push the latest changes, or merge a pull request to `master` if performing a hotfix.
8079
- If you don't have push access, open an issue or otherwise contact a contributor with administrator priveliges.
8180
- Create release tags. We currently follow [semver](https://semver.org/) standards.

0 commit comments

Comments
 (0)