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
+8-18Lines changed: 8 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ We use the [feature branch workflow](https://www.atlassian.com/git/tutorials/com
19
19
20
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.
21
21
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.
23
23
2. Review the PR:
24
24
-[ ] Changelog entries were created.
25
25
-[ ] Version number in package.json was bumped.
@@ -28,15 +28,11 @@ We use [Changesets](https://github.com/changesets/changesets) to automate versio
28
28
29
29
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
30
31
-
## Managing the Dockerfile & Docker Image
31
+
## Updating the Docker Image
32
32
33
33
The `Dockerfile` is hosted as a Docker image on DockerHub: [wpengine/sitedeploy](https://hub.docker.com/r/wpengine/site-deploy).
34
34
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.
40
36
41
37
### Automatic Builds
42
38
@@ -47,28 +43,25 @@ Docker images are built and pushed automatically:
47
43
| Push to `main`|`latest`| Docker Hub Autobuild |
48
44
| New version release |`latest`, `vX`, `vX.Y`, `vX.Y.Z`| Docker Hub Autobuild |
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.
52
49
53
50
### Base Image Maintenance
54
51
55
52
The Dockerfile uses Alpine Linux as its base image. The base image follows this update pattern:
56
53
57
54
-**Dependabot** monitors for new Alpine versions and creates PRs automatically
58
-
-**Scheduled rebuilds** pick up security patches from `apk upgrade` monthly
59
55
- Alpine releases new versions every 6 months (roughly June and December)
56
+
-**Scheduled rebuilds** pick up security patches from `apk upgrade` monthly
60
57
61
58
When Dependabot opens a PR for a new Alpine version:
62
59
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.
64
61
2. Add a changeset to the PR (`npx changeset`) so a proper release is created when merged
65
62
3. Merge the PR to trigger a new versioned release
66
63
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
72
65
73
66
You can also build and version this image using make targets when necessary.
74
67
@@ -78,6 +71,3 @@ make version # Builds the image and creates version tags
78
71
make list-images # Shows all tagged versions of the image
79
72
make clean # Deletes all tagged versions of the image
80
73
```
81
-
82
-
To push a custom version of the image to DockerHub:
0 commit comments