-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(docker): update docker image README and build script
Signed-off-by: Andrei Jiroh Halili <[email protected]>
- Loading branch information
1 parent
66bc6f5
commit 03c3292
Showing
2 changed files
with
29 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,33 @@ | ||
# Custom `mkdocs-material` CI image | ||
|
||
Builds on Alpine edge, mostly used by @ajhalili2006 to deploy | ||
builds over GitLab Ci. | ||
Builds on Alpine edge, mostly used by @ajhalili2006 to deploy builds over GitLab CI. | ||
|
||
## CI Status | ||
|
||
| Webhook Event | Badge | Frequency | | ||
| --- | --- | --- | | ||
| After push | [](https://github.com/ajhalili2006/website/actions/workflows/docker.yml) | As commits are mirrored to GitHub, either manually or asynchorously run in GitLab CI | | ||
| Nightly Builds | [](https://github.com/ajhalili2006/website/actions/workflows/docker.yml) | Runs every 22:30 UTC (6:30 PHT) | ||
|
||
## Usage | ||
|
||
See the tags list on [GitHub][ghcr] or [Red Hat Quay Container Registry Cloud][quay] | ||
|
||
[ghcr]: https://github.com/ajhalili2006/website/pkgs/container/website%2Fbuild-ci/versions | ||
[quay]: https://quay.io/repository/ajhalili2006/mkdocs-material-build-ci?tab=tags | ||
|
||
```yaml | ||
# in GitLab CI config... | ||
image: | ||
name: quay.io/ajhalili2006/mkdocs-material-build-ci:latest | ||
``` | ||
```dockerfile | ||
# ...or via your custom Docker image | ||
FROM ghcr.io/ajhalili2006/website/build-ci:latest | ||
``` | ||
|
||
## Build from source | ||
|
||
After cloning [Andrei Jiroh's website sources](https://mau.dev/andreijiroh.dev/website), you can run the `build.sh` script | ||
(see script source for available options) | ||
Run the `build.sh` script to generate a local build of the image. To overridethe default image tag, set `IMAGE_TAG` shell variable before running. | ||
If used as part of your CI, add any value to `DEPLOY` variable to run `docker push` for you. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters