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
Copy file name to clipboardExpand all lines: DEVELOPMENT.md
+13-27Lines changed: 13 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,40 +15,26 @@ We use the [feature branch workflow](https://www.atlassian.com/git/tutorials/com
15
15
5. Open a pull request to the `main` branch.
16
16
6. Once all checks are passing and the PR is approved, Squash and Merge into the `main` branch.
17
17
18
+
## Updating the Docker Image
19
+
20
+
The docker image that this action relies on is managed in https://github.com/wpengine/site-deploy. After a new `wpengine/site-deploy` image is released and tagged:
21
+
22
+
1. Create a new branch.
23
+
2. Update the tag in [./action.yml](./action.yml).
24
+
3. Use `npx changeset` to create a changeset describing the change to users.
25
+
4. Commit your changes.
26
+
5. Open a pull request to the `main` branch.
27
+
6. Once all checks are passing and the PR is approved, Squash and Merge into the `main` branch.
28
+
18
29
## Creating a release
19
30
20
-
We use [Changesets](https://github.com/changesets/changesets) to automate versioning and releasing. When you are ready to release, the first step is to create the new version.
31
+
We use [Changesets](https://github.com/changesets/changesets) to automate versioning and releasing.
21
32
22
-
1. Go to pull requests and view the "Version Action" PR.
33
+
1. Go to pull requests and view the automated "Version Action" PR.
23
34
2. Review the PR:
24
35
-[ ] Changelog entries were created.
25
36
-[ ] Version number in package.json was bumped.
26
37
-[ ] All `.changeset/*.md` files were removed.
27
38
3. Approve, then "Squash and merge" the PR into `main`.
28
39
29
40
Merging the versioning PR will run a workflow that creates or updates all necessary tags. It will also create a new release in GitHub.
30
-
31
-
## Managing the Dockerfile & Docker Image
32
-
33
-
The base of the `Dockerfile` is hosted as a Docker image on DockerHub. The image is originally built locally from `Dockerfiles/Dockerfile` and pushed up to DockerHub.
34
-
35
-
The main `Dockerfile` at the project root imports the `wpengine/gha:base-stable` hosted image from DockerHub. Customizations to the image should be added below the base image for code that is updated more frequently, such as:
36
-
- entrypoint.sh
37
-
- exclude.txt
38
-
39
-
All other customizations that are updated less frequently, or managed by 3rd parties, should be added to the `base-stable` image. Rebuild and push the image to DockerHub to update the image.
40
-
41
-
## Updating the Docker Image
42
-
The `base-stable` Docker Image will rarely need to be updated, however it may be necessary to update it manually* from time to time.
Once the hosted Docker image is updated, it will need to be imported (or updated) on the main project `Dockerfile`. If the Dockerhub tag name (image version) has changed, update the existing line in the project root `Dockerfile` to match the new tag name.
51
-
- Update the root Docker file for the project with the latest version of the Docker Image:tagname. i.e.:
52
-
`FROM wpengine/gha:base-stable`
53
-
54
-
_*TO DO: Process will be automated in the future._
0 commit comments