andreijiroh-dev/website
1
0
Fork 0
mirror of https://mau.dev/andreijiroh-dev/website.git synced 2024-11-12 20:32:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs(docker): update docker image README and build script

Browse source 
Signed-off-by: Andrei Jiroh Halili <ajhalili2006@andreijiroh.xyz>
This commit is contained in:
Andrei Jiroh Halili 2024-06-07 17:54:26 +08:00
parent 66bc6f5f84
commit 03c329238f
No known key found for this signature in database
GPG key ID: 67BFC91B3DA12BE8
2 changed files with 29 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
docker/README.md
View file

@ -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 | [![Docker CI](https://github.com/ajhalili2006/website/actions/workflows/docker.yml/badge.svg?event=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 | [![Docker CI](https://github.com/ajhalili2006/website/actions/workflows/docker.yml/badge.svg?event=schedule)](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.

2
docker/build.sh
View file

@ -6,7 +6,7 @@ CONTEXT=$ROOTDIR/docker
DOCKERFILE=$CONTEXT/Dockerfile
TAG=${IMAGE_TAG:-"quay.io/ajhalili2006/mkdocs-material-build-ci:localdev"}
DOCKER_BUILDKIT=${DOCKER_BUILDKIT:-"0"} \
DOCKER_BUILDKIT=${DOCKER_BUILDKIT:-"1"} \
docker build \
-t $TAG \
-f "$DOCKERFILE" \