docs: add quickstart
This commit is contained in:
parent
629215ea9a
commit
8e76c36040
16
README.md
16
README.md
@ -2,6 +2,22 @@
|
||||
|
||||
Various toolchain bits and pieces shared between projects
|
||||
|
||||
# Quickstart
|
||||
Create top-level Makefile
|
||||
```
|
||||
REGISTRY := <your-registry>
|
||||
IMAGE := <image_name>
|
||||
REGION := <AWS region of your registry>
|
||||
|
||||
include .ci/podman.mk
|
||||
```
|
||||
|
||||
Add subtree to your project:
|
||||
```
|
||||
git subtree add --prefix .ci https://git.zero-downtime.net/ZeroDownTime/ci-tools-lib.git master --squash
|
||||
```
|
||||
|
||||
|
||||
## Jenkins
|
||||
Shared groovy libraries
|
||||
|
||||
|
@ -52,5 +52,10 @@ rm-test-image:
|
||||
@test -z "$$(docker image ls -q $(IMAGE):$(TAG)-test)" || docker image rm -f $(IMAGE):$(TAG)-test > /dev/null
|
||||
@test -z "$$(docker image ls -q $(IMAGE):$(TAG)-test)" || echo "Error: Removing test image failed"
|
||||
|
||||
# Convience task during dev of downstream projects
|
||||
.PHONY: ci-pull-upstream
|
||||
ci-pull-upstream:
|
||||
git stash && git subtree pull --prefix .ci ssh://git@git.zero-downtime.net/ZeroDownTime/ci-tools-lib.git master --squash && git stash pop
|
||||
|
||||
.DEFAULT:
|
||||
@echo "$@ not implemented. NOOP"
|
||||
|
Loading…
Reference in New Issue
Block a user