Skip to content

Commit 51b0c9c

Browse files
authored
Update DEVELOPMENT.md (#56)
Polishing the DEVELOPMENT.md documentation for accuracy and clarity
1 parent c228aa2 commit 51b0c9c

1 file changed

Lines changed: 8 additions & 18 deletions

File tree

DEVELOPMENT.md

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ We use the [feature branch workflow](https://www.atlassian.com/git/tutorials/com
1919

2020
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.
2121

22-
1. Go to pull requests and view the "Version Action" PR.
22+
1. Go to pull requests and view the automated "Version Image" PR.
2323
2. Review the PR:
2424
- [ ] Changelog entries were created.
2525
- [ ] Version number in package.json was bumped.
@@ -28,15 +28,11 @@ We use [Changesets](https://github.com/changesets/changesets) to automate versio
2828

2929
Merging the versioning PR will run a workflow that creates or updates all necessary tags. It will also create a new release in GitHub.
3030

31-
## Managing the Dockerfile & Docker Image
31+
## Updating the Docker Image
3232

3333
The `Dockerfile` is hosted as a Docker image on DockerHub: [wpengine/sitedeploy](https://hub.docker.com/r/wpengine/site-deploy).
3434

35-
The Docker image is used in both [wpengine/github-action-wpe-site-deploy](https://github.com/wpengine/github-action-wpe-site-deploy) GitHub Action and the [azunigawpe/wpe-bb-deploy](https://bitbucket.org/azunigawpe/wpe-bb-deploy/src/main/) BitBucket Pipeline. Any customizations to the image should consider the effect on both services.
36-
37-
Any other customizations that are uniquely required can be added to the Dockerfile in the project itself.
38-
39-
## Updating the Docker Image
35+
The Docker image is used in both [wpengine/github-action-wpe-site-deploy](https://github.com/wpengine/github-action-wpe-site-deploy) GitHub Action and the [wpengine/wpe-site-deploy]([https://bitbucket.org/azunigawpe/wpe-bb-deploy/src/main/](https://bitbucket.org/wpengine/wpe-site-deploy/src/main/)) Bitbucket Pipe. Any customizations to the image should consider the effect on both services.
4036

4137
### Automatic Builds
4238

@@ -47,28 +43,25 @@ Docker images are built and pushed automatically:
4743
| Push to `main` | `latest` | Docker Hub Autobuild |
4844
| New version release | `latest`, `vX`, `vX.Y`, `vX.Y.Z` | Docker Hub Autobuild |
4945
| Monthly schedule (1st of month) | `latest`, `vX`, `vX.Y`, `vX.Y.Z` | GitHub Actions |
46+
| Manual trigger | `latest`, `vX`, `vX.Y`, `vX.Y.Z` | GitHub Actions |
5047

51-
The scheduled monthly rebuild ensures security patches are applied even when there are no new releases. This workflow uses `no-cache` to pull fresh base image layers.
48+
The scheduled monthly rebuild ensures security patches are applied even when there are no new releases. Both the scheduled and manually triggered workflows use `no-cache` to pull fresh base image layers.
5249

5350
### Base Image Maintenance
5451

5552
The Dockerfile uses Alpine Linux as its base image. The base image follows this update pattern:
5653

5754
- **Dependabot** monitors for new Alpine versions and creates PRs automatically
58-
- **Scheduled rebuilds** pick up security patches from `apk upgrade` monthly
5955
- Alpine releases new versions every 6 months (roughly June and December)
56+
- **Scheduled rebuilds** pick up security patches from `apk upgrade` monthly
6057

6158
When Dependabot opens a PR for a new Alpine version:
6259

63-
1. Review the [Alpine release notes](https://alpinelinux.org/releases/) for breaking changes
60+
1. Review the [Alpine release notes](https://alpinelinux.org/releases/) for breaking changes and ensure tests are passing.
6461
2. Add a changeset to the PR (`npx changeset`) so a proper release is created when merged
6562
3. Merge the PR to trigger a new versioned release
6663

67-
### Docker Hub
68-
69-
Images are published to DockerHub: [wpengine/site-deploy](https://hub.docker.com/r/wpengine/site-deploy)
70-
71-
## Manually updating the Docker Image
64+
## Building and versioning locally
7265

7366
You can also build and version this image using make targets when necessary.
7467

@@ -78,6 +71,3 @@ make version # Builds the image and creates version tags
7871
make list-images # Shows all tagged versions of the image
7972
make clean # Deletes all tagged versions of the image
8073
```
81-
82-
To push a custom version of the image to DockerHub:
83-
`docker push wpengine/site-deploy:{tagName}`

0 commit comments

Comments
 (0)