Skip to content

Commit f7c68a6

Browse files
authored
Merge pull request #10325 from ethereum/staging
Deploy v7.12.3
2 parents 469d5dd + 81ce541 commit f7c68a6

File tree

99 files changed

+1818
-1044
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

99 files changed

+1818
-1044
lines changed

.github/workflows/chromatic.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@ name: Chromatic Publish and Testing
55

66
# Event for the workflow
77
on:
8-
push:
8+
pull_request:
9+
types:
10+
- opened
11+
- synchronize
12+
- ready_for_review
913
paths:
1014
# Only run on file changes in any of these paths
1115
- "src/components/**/*"

.github/workflows/docsearch-crawl.yml

Lines changed: 0 additions & 27 deletions
This file was deleted.

.github/workflows/docsearchConfig.json

Lines changed: 0 additions & 123 deletions
This file was deleted.

.github/workflows/docsearchConfigScript.js

Lines changed: 0 additions & 63 deletions
This file was deleted.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,12 +144,12 @@ In case you want to test them as if you were in a Netlify env, you can install t
144144
- See [how decisions are made on content changes](https://ethereum.org/en/contributing/#how-decisions-about-the-site-are-made)
145145
- Acceptable PRs will be approved & merged into the `dev` branch
146146

147-
Learn more about how we review pull requests [here](docs/deploy-and-review-process.md).
147+
Learn more about how we review pull requests [here](docs/review-process.md).
148148

149149
### 8. Release
150150

151151
- `master` is continually synced to Netlify and will automatically deploy new commits to ethereum.org
152-
- The [website team](https://ethereum.org/en/contributing/#how-decisions-about-the-site-are-made) will create deploys and merge `dev` into `master`. This happens on Tuesdays and Thursdays every week. More info on deploys and review process [here](docs/deploy-and-review-process.md).
152+
- Learn more about how we deploy the site [here](docs/deploy-process.md)
153153
- You can [view the history of releases](https://github.com/ethereum/ethereum-org-website/releases), which include PR highlights
154154

155155
<hr style="margin-top: 3em; margin-bottom: 3em;">

docs/deploy-process.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# Ethereum.org deploy process
2+
3+
Ethereum.org follows a [Gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) workflow for managing and deploying the codebase.
4+
5+
## Deploy process
6+
7+
The current process for deployment involves a 2-day QA cycle to test a release candidate. A release candidate is created on Tuesday, will have 2 days of testing, and then released to production on Thursday assuming no blocking bugs are found.
8+
9+
The typical workflow will be as follows:
10+
11+
1. A branch is created off of the `dev` branch, and pull requests for the branch are created into `dev`
12+
2. Pull requests are reviewed, and merged into `dev`
13+
3. On Tuesday, a pull request is created into the `staging` branch
14+
- At this point, the `staging` branch will be the release candidate. At this point, no new features are added into staging for the release, only release blocking bugfixes.
15+
4. During the next 2 days (Tuesday - Thursday) QA testing on the release candidate takes place
16+
- During QA testing, any bugs found will be filed under two categories:
17+
- Release blocking: if a bug is considered blocking for the release, create an issue and triage for a pull request to fix before release
18+
- Non-release blocking: if a bug is not blocking a release, create an issue and triage normally
19+
5. If any release blocking bugfixes are merged into `staging`, bring those changes into `dev`
20+
6. When a release candidate is ready for release, merge into `master` and deploy to production on Thursday
21+
7. Create a tag for the new version in master
22+
8. Merge tag into `staging` and `dev`
23+
24+
```
25+
master O (tag) - - - - - - - - - - - - O (tag)
26+
27+
| /
28+
29+
staging O - - - - - - - - - O - - - O
30+
31+
| / \
32+
33+
dev O - - - - O - - - - O - - O - O
34+
35+
\ \ / /
36+
37+
feature1 \ _ \ _ _ O /
38+
39+
feature 2 \ _ _ O
40+
```
41+
42+
## Release blocking bugfix process
43+
44+
In the event that a bug was found in `staging` during the QA cycle that blocks a release, the following steps will take place to address the bug:
45+
46+
1. Create an issue in GitHub documenting the bug
47+
2. Triage issue to a developer
48+
3. Developer will create a branch off of `staging`
49+
4. Work on bugfix
50+
5. Create a pull request into `staging`
51+
6. Merge into `staging` after review
52+
7. Merge `staging` back into `dev` after the bugfix has been merged
53+
54+
```
55+
master O (tag) - - - - - - - - - - - - - - - - - - - O (tag)
56+
57+
| /
58+
59+
| bugfix O - O /
60+
61+
| / \ /
62+
63+
staging O - - - - - - - - - O - - - - O - - O
64+
65+
| / \
66+
67+
dev O - - - - O - - O - O - - - O - - - - - O
68+
```
69+
70+
## Hotfix process
71+
72+
In the event that a hotfix is found in production and needs to be addressed before the next release
73+
74+
1. Create an issue in GitHub documenting the bug
75+
2. Triage issue to a developer
76+
3. Developer will create a branch off of `master`
77+
4. Work on hotfix
78+
5. Create a pull request into `master`
79+
6. After review, merge hotfix pull request into `master` and release into production
80+
7. Merge `master` into `staging` and `dev` branches
81+
82+
```
83+
hotfix O - - - O
84+
85+
/ \
86+
87+
master O - - - - - - - O (tag)
88+
89+
| |
90+
91+
staging O - - - - - - - O
92+
93+
| |
94+
95+
dev O - - O - - - - O
96+
```

docs/deploy-and-review-process.md renamed to docs/review-process.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
1-
# Deploy and pull request review process
1+
# Pull request review process
22

3-
This documentation outlines our current processes for how we deploy the latest changes to ethereum.org, and how we prioritize items in our pull request review process.
4-
5-
## Deploy process
6-
7-
Anything merged into the `dev` branch of [ethereum.org](http://ethereum.org) will go live on ethereum.org at the next release. Currently, we deploy the latest changes to [ethereum.org](http://ethereum.org) twice per week (Tuesday and Thursday). When deploying, we merge the `dev` branch into the `master` branch. The `master` branch is the latest live version of [ethereum.org](https://ethereum.org).
8-
9-
Occasionally, we’ll also do a patch deploy to fix an urgent or widespread issue.
3+
This documentation outlines our current processes for how we prioritize items in our pull request review process.
104

115
## Pull request review process
126

0 commit comments

Comments
 (0)