From 05a536a17da3ab8e7f3224c6042687804b0dcac9 Mon Sep 17 00:00:00 2001 From: Adora Laura Kalb Date: Tue, 30 Jul 2024 08:42:51 +0200 Subject: [PATCH 1/3] add makefile --- .gitignore | 41 ++++++++++------------ .vscode/launch.json | 4 +-- Makefile | 13 +++++++ cmd/certwarden-deploy/{root.go => main.go} | 6 ++-- internal/constants/constants.go | 6 ++-- main.go | 11 ------ 6 files changed, 40 insertions(+), 41 deletions(-) create mode 100644 Makefile rename cmd/certwarden-deploy/{root.go => main.go} (86%) delete mode 100644 main.go diff --git a/.gitignore b/.gitignore index d94d697..4f1f4eb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,31 +1,28 @@ -# ---> Go -# If you prefer the allow list template instead of the deny list, see community template: -# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore +# Allowlisting gitignore template for GO projects prevents us +# from adding various unwanted local files, such as generated +# files, developer configurations or IDE-specific files etc. # -# Binaries for programs and plugins -*.exe -*.exe~ -*.dll -*.so -*.dylib +# Recommended: Go.AllowList.gitignore -# Test binary, built with `go test -c` -*.test +# Ignore everything +* -# Output of the go coverage tool, specifically when used with LiteIDE -*.out +# But not these files... +!/.gitignore -# Dependency directories (remove the comment below to include it) -# vendor/ +!*.go +!go.sum +!go.mod -# Go workspace file -go.work +!examples/* -bin/ +!*.md +!LICENSE -examples/testing/ +!Makefile -*.yaml -!examples/*.yaml +# Woodpecker CI +!.woodpecker/* -test/ +# ...even if they are in subdirectories +!*/ diff --git a/.vscode/launch.json b/.vscode/launch.json index d4a07bf..053205a 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -9,7 +9,7 @@ "type": "go", "request": "launch", "mode": "auto", - "program": "${workspaceFolder}", + "program": "${workspaceFolder}/cmd/certwarden-deploy/main.go", "args": ["--config", "${workspaceFolder}/config.yaml", "--dry-run"] }, { @@ -17,7 +17,7 @@ "type": "go", "request": "launch", "mode": "auto", - "program": "${workspaceFolder}", + "program": "${workspaceFolder}/cmd/certwarden-deploy/main.go", "args": ["--config", "${workspaceFolder}/config.yaml", "--verbose"] } ] diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..9cd8f31 --- /dev/null +++ b/Makefile @@ -0,0 +1,13 @@ +# Set the default Go build flags +GOFLAGS = -ldflags='-w -s -X constants.Version=$(VERSION)' + +# Build the application +build: + go build $(GOFLAGS) -o bin/certwarden-deploy cmd/certwarden-deploy/main.go + +# Clean the build artifacts +clean: + rm -rf bin + +# Set a version for the build +VERSION := $(shell git describe --tags --always) diff --git a/cmd/certwarden-deploy/root.go b/cmd/certwarden-deploy/main.go similarity index 86% rename from cmd/certwarden-deploy/root.go rename to cmd/certwarden-deploy/main.go index 6bbbceb..bce2d8d 100644 --- a/cmd/certwarden-deploy/root.go +++ b/cmd/certwarden-deploy/main.go @@ -2,7 +2,7 @@ Copyright © 2024 Laura Kalb The code of this project is available under the MIT license. See the LICENSE file for more info. */ -package cmd +package main import ( "os" @@ -11,9 +11,7 @@ import ( "code.lila.network/adoralaura/certwarden-deploy/internal/configuration" ) -// Execute adds all child commands to the root command and sets flags appropriately. -// This is called by main.main(). It only needs to happen once to the rootCmd. -func Execute() { +func main() { err := cli.RootCmd.Execute() if err != nil { os.Exit(1) diff --git a/internal/constants/constants.go b/internal/constants/constants.go index 75f2492..a427830 100644 --- a/internal/constants/constants.go +++ b/internal/constants/constants.go @@ -1,7 +1,9 @@ package constants -const Version = "0.2.1" +var Version string + +var UserAgent = "certwarden-deploy/" + Version + " +https://code.lila.network/adoralaura/certwarden-deploy" + const CertificateApiPath = "/certwarden/api/v1/download/certificates/" const KeyApiPath = "/certwarden/api/v1/download/privatekeys/" const ApiKeyHeaderName = "X-API-Key" -const UserAgent = "certwarden-deploy/" + Version + " +https://code.lila.network/adoralaura/certwarden-deploy" diff --git a/main.go b/main.go deleted file mode 100644 index 588fd19..0000000 --- a/main.go +++ /dev/null @@ -1,11 +0,0 @@ -/* -Copyright © 2024 Laura Kalb -The code of this project is available under the MIT license. See the LICENSE file for more info. -*/ -package main - -import cmd "code.lila.network/adoralaura/certwarden-deploy/cmd/certwarden-deploy" - -func main() { - cmd.Execute() -} -- 2.39.5 From b8ec72877d78cbda58212105161a0fb08412d383 Mon Sep 17 00:00:00 2001 From: Adora Laura Kalb Date: Tue, 30 Jul 2024 08:48:48 +0200 Subject: [PATCH 2/3] update CI --- .woodpecker/build-and-deploy.yml | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/.woodpecker/build-and-deploy.yml b/.woodpecker/build-and-deploy.yml index f79927f..30837c8 100644 --- a/.woodpecker/build-and-deploy.yml +++ b/.woodpecker/build-and-deploy.yml @@ -20,13 +20,13 @@ steps: - APP_NAME=certwarden-deploy - FORGE=https://code.lila.network commands: - - apk add --update --no-cache xz curl jq - - go mod download - - go build -o output/$APP_NAME-${CI_COMMIT_TAG##v}-${GOOS}-${GOARCH}${GOARM} main.go - - cd output - - xz --keep --compress $APP_NAME-${CI_COMMIT_TAG##v}-${GOOS}-${GOARCH}${GOARM} - - sha256sum $APP_NAME-${CI_COMMIT_TAG##v}-${GOOS}-${GOARCH}${GOARM} >> $APP_NAME-${CI_COMMIT_TAG##v}-${GOOS}-${GOARCH}${GOARM}.sha256 - - sha256sum $APP_NAME-${CI_COMMIT_TAG##v}-${GOOS}-${GOARCH}${GOARM}.xz >> $APP_NAME-${CI_COMMIT_TAG##v}-${GOOS}-${GOARCH}${GOARM}.xz.sha256 + - apk add --update --no-cache xz curl jq make + - make build + - cd bin/ + - mv $APP_NAME $APP_NAME-${GOOS}-${GOARCH}${GOARM} + - xz --keep --compress $APP_NAME-${GOOS}-${GOARCH}${GOARM} + - sha256sum $APP_NAME-${GOOS}-${GOARCH}${GOARM} >> $APP_NAME-${GOOS}-${GOARCH}${GOARM}.sha256 + - sha256sum $APP_NAME-${GOOS}-${GOARCH}${GOARM}.xz >> $APP_NAME-${GOOS}-${GOARCH}${GOARM}.xz.sha256 - |- export RELEASE_ID=`curl --location "$FORGE/api/v1/repos/$CI_REPO/releases?limit=10" \ --header 'Accept: application/json' -s -S \ @@ -35,23 +35,23 @@ steps: curl --location "$FORGE/api/v1/repos/$CI_REPO/releases/$RELEASE_ID/assets" \ --header "Authorization: token $FORGEJO_APIKEY" \ --header 'Content-Type: multipart/form-data' -s -S \ - --form "attachment=@$APP_NAME-${CI_COMMIT_TAG##v}-${GOOS}-${GOARCH}${GOARM};type=application/octet-stream" \ + --form "attachment=@$APP_NAME-${GOOS}-${GOARCH}${GOARM};type=application/octet-stream" \ --fail-with-body - |- curl --location "$FORGE/api/v1/repos/$CI_REPO/releases/$RELEASE_ID/assets" \ --header "Authorization: token $FORGEJO_APIKEY" \ --header 'Content-Type: multipart/form-data' -s -S \ - --form "attachment=@$APP_NAME-${CI_COMMIT_TAG##v}-${GOOS}-${GOARCH}${GOARM}.xz;type=application/octet-stream" \ + --form "attachment=@$APP_NAME-${GOOS}-${GOARCH}${GOARM}.xz;type=application/octet-stream" \ --fail-with-body - |- curl --location "$FORGE/api/v1/repos/$CI_REPO/releases/$RELEASE_ID/assets" \ --header "Authorization: token $FORGEJO_APIKEY" \ --header 'Content-Type: multipart/form-data' -s -S \ - --form "attachment=@$APP_NAME-${CI_COMMIT_TAG##v}-${GOOS}-${GOARCH}${GOARM}.sha256;type=application/octet-stream" \ + --form "attachment=@$APP_NAME-${GOOS}-${GOARCH}${GOARM}.sha256;type=application/octet-stream" \ --fail-with-body - |- curl --location "$FORGE/api/v1/repos/$CI_REPO/releases/$RELEASE_ID/assets" \ --header "Authorization: token $FORGEJO_APIKEY" \ --header 'Content-Type: multipart/form-data' -s -S \ - --form "attachment=@$APP_NAME-${CI_COMMIT_TAG##v}-${GOOS}-${GOARCH}${GOARM}.xz.sha256;type=application/octet-stream" \ + --form "attachment=@$APP_NAME-${GOOS}-${GOARCH}${GOARM}.xz.sha256;type=application/octet-stream" \ --fail-with-body -- 2.39.5 From 6f2077971436849167c2bdaf3ffcb57f20cc01a1 Mon Sep 17 00:00:00 2001 From: Adora Laura Kalb Date: Tue, 30 Jul 2024 08:49:00 +0200 Subject: [PATCH 3/3] bump version to 0.2.2 --- CHANGELOG.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3213134..5cc7774 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [0.2.2] - 2024-07-30 + +### Changed +- changed the way the version string is handled internally +- CI pipeline changed +- documentation is now more sophisticated and has a new theme + +### Added +- Makefile + ## [0.2.1] - 2024-07-12 ### Fixed - Configuration validation did not work as intended @@ -40,7 +50,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - some documentation -[unreleased]: https://code.lila.network/adoralaura/certwarden-deploy/compare/0.2.1...HEAD +[unreleased]: https://code.lila.network/adoralaura/certwarden-deploy/compare/0.2.2...HEAD +[0.2.2]: https://code.lila.network/adoralaura/certwarden-deploy/compare/0.2.1...0.2.2 [0.2.1]: https://code.lila.network/adoralaura/certwarden-deploy/compare/0.2.0...0.2.1 [0.2.0]: https://code.lila.network/adoralaura/certwarden-deploy/compare/0.1.1...0.2.0 [0.1.1]: https://code.lila.network/adoralaura/certwarden-deploy/compare/0.1.0...0.1.1 -- 2.39.5