crypt/certbot
1
0
Fork 0
mirror of https://github.com/certbot/certbot.git synced 2026-01-26 07:41:33 +03:00
Code Activity

Grammar improvements (#18)

Browse Source 
Update the README with improved grammar.
This commit is contained in:
ohemorange
2020-02-05 16:08:57 -08:00
committed by GitHub
parent a180d5d5c9
commit bca73f9932
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
tools/docker/README.md
View File

@@ -4,20 +4,20 @@ Certbot-Docker project
Goal
----
This project is used to publish on DockerHub a new version of the official Certbot Docker, and related Certbot DNS plugins Dockers, upon release of a new version of Certbot.
This project is used to publish a new version of the official Certbot Docker and related Certbot DNS plugins Dockers on DockerHub upon release of a new version of Certbot.
It leverages the AutoBuild features of DockerHub to coordinate this publication through a continous integration/deployment approach.
High-level behavior
-------------------
When a new version tag (eg. v0.35.0) is pushed to this repository, it triggers a new build in each DockerHub project, to construct and publish the new version of the Docker,
containing the Certbot version corresponding to the pushed tag. With the example of the v0.35.0, the DockerHub projects will contain after few minutes a new tag v0.35.0,
whose the Docker contains Certbot v0.35.0.
When a new version tag (eg. v0.35.0) is pushed to this repository, it triggers a new build in each DockerHub project, to construct and publish the new version of the Docker
containing the Certbot version corresponding to the pushed tag. For example, after following the instructions for v0.35.0 below, after a few minutes the DockerHub projects will contain a new tag "v0.35.0",
whose Docker contains Certbot v0.35.0.
Configuration
-------------
To setup the publication process, the target DockerHub project must be configured appropriately. There are two types of DockerHub projects to take into account:
To set up the publication process, the target DockerHub project must be configured appropriately. There are two types of DockerHub projects to take into account:
* the Docker project for Certbot core features (eg. certbot/certbot)
* a Docker project for Certbot DNS plugins (eg. certbot/dns-rfc2136)
@@ -35,9 +35,9 @@ Publication worfklow
Assuming the version to publish is `v0.35.0`
1) Clone this repository locally, checkout branch `master` and ensure to have a clean workspace.
2) (Optional) Execute `./build.sh v0.35.0` to test the Dockers builds.
3) Execute `./deploy.sh v0.35.0` to trigger the publication of all Dockers with `v0.35.0` version.
1) Clone this repository locally, check out branch `master`, and ensure the workspace is clean.
2) (Optional) Execute `./build.sh v0.35.0` to test the Docker builds.
3) Execute `./deploy.sh v0.35.0` to trigger the publication of all Dockers with version `v0.35.0`.
Scripts usage
-------------
@@ -46,16 +46,16 @@ Scripts usage
./build.sh [VERSION]
```
This script will build locally all Dockers for the given version using the same runtime than DockerHub.
This script will locally build all Dockers for the given version using the same runtime as DockerHub.
This can be used to test the build process before invoking the actual publication workflow.
```
./deploy [VERSION]
```
This script will trigger the publication on DockerHub of all Dockers for the given version. To do so, this script:
- update the relevant `README.md` files that will be used as description in the DockerHub repositories,
- commit locally the modifications,
This script will trigger the publication of all Dockers for the given version to DockerHub. To do so, this script will:
- update the relevant `README.md` files that will be used as descriptions in the DockerHub repositories,
- locally commit the modifications,
- tag this commit with the given version,
- push this tag and the updated `master` branch.