Skip to content

Commit fa6d1aa

Browse files
authored
Update DEVELOPMENT.md (#130)
Updating development docs for accuracy and clarity.
1 parent 7bdbfb6 commit fa6d1aa

File tree

1 file changed

+13
-27
lines changed

1 file changed

+13
-27
lines changed

DEVELOPMENT.md

Lines changed: 13 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -15,40 +15,26 @@ We use the [feature branch workflow](https://www.atlassian.com/git/tutorials/com
1515
5. Open a pull request to the `main` branch.
1616
6. Once all checks are passing and the PR is approved, Squash and Merge into the `main` branch.
1717

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+
1829
## Creating a release
1930

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.
2132

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.
2334
2. Review the PR:
2435
- [ ] Changelog entries were created.
2536
- [ ] Version number in package.json was bumped.
2637
- [ ] All `.changeset/*.md` files were removed.
2738
3. Approve, then "Squash and merge" the PR into `main`.
2839

2940
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.
43-
44-
- Build the docker image locally:
45-
`docker build --no-cache -t wpengine/gha:base-stable Dockerfiles`
46-
47-
- Push the image to DockerHub:
48-
`docker push wpengine/gha:base-stable`
49-
50-
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

Comments
 (0)