From 793fd268048b7fce4bbc74d065e59b2b6022cb1e Mon Sep 17 00:00:00 2001 From: Alexis Couvreur Date: Mon, 9 Jan 2023 14:16:19 -0500 Subject: [PATCH 1/3] docs: use docker registry everywhere Ghcr was mostly used, switched to docker registry in order to have a consistent documentation --- .github/workflows/plugins.yml | 2 +- docs/THEMES.md | 2 +- plugins/traefik/README.md | 2 +- plugins/traefik/e2e/docker-compose.yml | 2 +- plugins/traefik/e2e/docker-stack.yml | 2 +- plugins/traefik/e2e/kubernetes.sh | 4 ++-- plugins/traefik/e2e/manifests/sablier.yml | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/plugins.yml b/.github/workflows/plugins.yml index 449a117..cfe5a10 100644 --- a/.github/workflows/plugins.yml +++ b/.github/workflows/plugins.yml @@ -23,7 +23,7 @@ jobs: with: context: . file: ./Dockerfile - tags: ghcr.io/acouvreur/sablier:local + tags: acouvreur/sablier:local outputs: type=docker,dest=/tmp/sablier.tar - name: Upload artifact diff --git a/docs/THEMES.md b/docs/THEMES.md index 9696883..4319243 100644 --- a/docs/THEMES.md +++ b/docs/THEMES.md @@ -21,7 +21,7 @@ version: 3.9 services: sablier: - image: ghcr.io/acouvreur/sablier:local + image: acouvreur/sablier:local volumes: - '/var/run/docker.sock:/var/run/docker.sock' - '/path/to/my/themes:/etc/sablier/themes' diff --git a/plugins/traefik/README.md b/plugins/traefik/README.md index 7414472..e673e95 100644 --- a/plugins/traefik/README.md +++ b/plugins/traefik/README.md @@ -79,7 +79,7 @@ services: - './dynamic-config.yml:/etc/traefik/dynamic-config.yml' sablier: - image: ghcr.io/acouvreur/sablier:local + image: acouvreur/sablier:local command: - start - --provider.name=docker diff --git a/plugins/traefik/e2e/docker-compose.yml b/plugins/traefik/e2e/docker-compose.yml index 53359b5..e447ef8 100644 --- a/plugins/traefik/e2e/docker-compose.yml +++ b/plugins/traefik/e2e/docker-compose.yml @@ -17,7 +17,7 @@ services: restart: "no" sablier: - image: ghcr.io/acouvreur/sablier:local + image: acouvreur/sablier:local command: - start - --provider.name=docker diff --git a/plugins/traefik/e2e/docker-stack.yml b/plugins/traefik/e2e/docker-stack.yml index 6838303..1529b09 100644 --- a/plugins/traefik/e2e/docker-stack.yml +++ b/plugins/traefik/e2e/docker-stack.yml @@ -24,7 +24,7 @@ services: condition: none # Do not restart on setup failure sablier: - image: ghcr.io/acouvreur/sablier:local + image: acouvreur/sablier:local command: - start - --provider.name=swarm diff --git a/plugins/traefik/e2e/kubernetes.sh b/plugins/traefik/e2e/kubernetes.sh index 42bbdb5..ea49913 100644 --- a/plugins/traefik/e2e/kubernetes.sh +++ b/plugins/traefik/e2e/kubernetes.sh @@ -13,8 +13,8 @@ docker version prepare_kubernetes() { docker compose -f $DOCKER_COMPOSE_FILE -p $DOCKER_COMPOSE_PROJECT_NAME up -d until kubectl get nodes | grep " Ready "; do sleep 1; done - echo "Loading ghcr.io/acouvreur/sablier:local into k3s..." - docker save ghcr.io/acouvreur/sablier:local | docker exec -i ${DOCKER_COMPOSE_PROJECT_NAME}-server-1 ctr images import - + echo "Loading acouvreur/sablier:local into k3s..." + docker save acouvreur/sablier:local | docker exec -i ${DOCKER_COMPOSE_PROJECT_NAME}-server-1 ctr images import - echo "Loading succeeded." } diff --git a/plugins/traefik/e2e/manifests/sablier.yml b/plugins/traefik/e2e/manifests/sablier.yml index 320c148..7b8124e 100644 --- a/plugins/traefik/e2e/manifests/sablier.yml +++ b/plugins/traefik/e2e/manifests/sablier.yml @@ -19,7 +19,7 @@ spec: serviceAccount: sablier containers: - name: sablier - image: ghcr.io/acouvreur/sablier:local + image: acouvreur/sablier:local args: ["start", "--provider.name=kubernetes", "--logging.level=trace"] ports: - containerPort: 10000 From 2aaeecd88ba97a29c37f92d46f2668a8c225f3ed Mon Sep 17 00:00:00 2001 From: Alexis Couvreur Date: Mon, 9 Jan 2023 14:26:39 -0500 Subject: [PATCH 2/3] docs: bump version to `1.2.0` to prepare automated version update --- README.md | 4 ++-- docker-compose.yml | 2 +- docs/THEMES.md | 2 +- docs/guides/code-server-traefik-kubernetes.md | 2 +- plugins/traefik/README.md | 4 ++-- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 35e5dae..36116a9 100644 --- a/README.md +++ b/README.md @@ -183,7 +183,7 @@ sablier --help # or docker run acouvreur/sablier[:version] --help -# ex: docker run acouvreur/sablier:v1.0.0 --help +# ex: docker run acouvreur/sablier:1.2.0 --help ``` All arguments can be used in the form of the config file such as @@ -219,7 +219,7 @@ Choose one of the Docker images and run it with one sample configuration file: ```bash docker run -d -p 10000:10000 \ - -v $PWD/sablier.yml:/etc/sablier/sablier.yml acouvreur/sablier:1.1.0 + -v $PWD/sablier.yml:/etc/sablier/sablier.yml acouvreur/sablier:1.2.0 ``` ### Use the binary distribution diff --git a/docker-compose.yml b/docker-compose.yml index 7d9d3bf..1e9ed74 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -16,7 +16,7 @@ services: - './dynamic-config.yml:/etc/traefik/dynamic-config.yml' sablier: - image: acouvreur/sablier:1.1.0 + image: acouvreur/sablier:1.2.0 volumes: - '/var/run/docker.sock:/var/run/docker.sock' labels: diff --git a/docs/THEMES.md b/docs/THEMES.md index 4319243..92b346b 100644 --- a/docs/THEMES.md +++ b/docs/THEMES.md @@ -21,7 +21,7 @@ version: 3.9 services: sablier: - image: acouvreur/sablier:local + image: acouvreur/sablier:1.2.0 volumes: - '/var/run/docker.sock:/var/run/docker.sock' - '/path/to/my/themes:/etc/sablier/themes' diff --git a/docs/guides/code-server-traefik-kubernetes.md b/docs/guides/code-server-traefik-kubernetes.md index 4f36581..b5c598a 100644 --- a/docs/guides/code-server-traefik-kubernetes.md +++ b/docs/guides/code-server-traefik-kubernetes.md @@ -152,7 +152,7 @@ serviceAccount: sablier containers: - name: sablier - image: acouvreur/sablier:1.1.1 + image: acouvreur/sablier:1.2.0 args: - "start" - "--provider.name=kubernetes" diff --git a/plugins/traefik/README.md b/plugins/traefik/README.md index e673e95..c54e4f4 100644 --- a/plugins/traefik/README.md +++ b/plugins/traefik/README.md @@ -17,7 +17,7 @@ experimental: plugins: sablier: moduleName: "github.com/acouvreur/sablier" - version: "v1.0.0" + version: "v1.2.0" ``` 2. Configure the plugin using the Dynamic Configuration. Example: @@ -79,7 +79,7 @@ services: - './dynamic-config.yml:/etc/traefik/dynamic-config.yml' sablier: - image: acouvreur/sablier:local + image: acouvreur/sablier:1.2.0 command: - start - --provider.name=docker From 13d75c18fc0daa14dc2d1f9a37bb0038441087ba Mon Sep 17 00:00:00 2001 From: Alexis Couvreur Date: Fri, 13 Jan 2023 02:44:46 -0500 Subject: [PATCH 3/3] ci(docs): add automated version change for documentation fixes #99 --- Makefile | 10 +++++++++- release.config.js | 7 +++++++ 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 7e03a3f..083d965 100644 --- a/Makefile +++ b/Makefile @@ -18,4 +18,12 @@ $(PLATFORMS): CGO_ENABLED=0 GOOS=$(os) GOARCH=$(arch) go build -tags=nomsgpack -v -ldflags="${GO_LDFLAGS}" -o 'sablier_$(VERSION)_$(os)-$(arch)' . release: $(PLATFORMS) -.PHONY: release $(PLATFORMS) \ No newline at end of file +.PHONY: release $(PLATFORMS) + +LAST = 0.0.0 +NEXT = 1.0.0 +update-doc-version: + find . -type f \( -name "*.md" -o -name "*.yml" \) -exec sed -i 's/acouvreur\/sablier:$(LAST)/acouvreur\/sablier:$(NEXT)/g' {} + + +update-doc-version-middleware: + find . -type f \( -name "*.md" -o -name "*.yml" \) -exec sed -i 's/version: "v$(LAST)"/version: "v$(NEXT)"/g' {} + \ No newline at end of file diff --git a/release.config.js b/release.config.js index 78a22e7..6ab086d 100644 --- a/release.config.js +++ b/release.config.js @@ -13,6 +13,13 @@ module.exports = { "assets": [ "sablier*" ] + }], + ["@semantic-release/exec", { + "publishCmd": "make LAST=${lastRelease.version} NEXT=${nextRelease.version} update-doc-version update-doc-version-middleware" + }], + ["@semantic-release/git", { + "assets": ["**/*.{md,yml}"], + "message": "docs(release): update doc version from ${lastRelease.version} to ${nextRelease.version} [skip ci]" }] ] } \ No newline at end of file