From 0e78a450f30d6613fbfea3c99d82be6a193ea5e7 Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Wed, 16 Aug 2023 00:15:24 +0200 Subject: [PATCH] refactor: initial commit after rewrite to woodpecker --- .chglog/config.yml | 2 +- .drone.yml | 297 ------------------ .github/settings.yml | 15 +- .gitignore | 2 +- .prettierignore | 1 - .woodpecker/build-binary.yml | 44 +++ .woodpecker/build-container.yml | 66 ++++ .woodpecker/docs.yml | 72 +++++ .woodpecker/notify.yml | 30 ++ .woodpecker/test.yml | 22 ++ ...rfile.multiarch => Containerfile.multiarch | 12 +- Makefile | 6 +- README.md | 24 +- _docs/content/_index.md | 34 +- _docs/data/data.yaml | 7 +- cmd/drone-matrix/main.go | 70 ----- cmd/{drone-matrix => wp-matrix}/config.go | 18 +- cmd/wp-matrix/main.go | 34 ++ go.mod | 17 +- go.sum | 31 +- plugin/impl.go | 56 ++-- plugin/plugin.go | 36 ++- 22 files changed, 408 insertions(+), 488 deletions(-) delete mode 100644 .drone.yml create mode 100644 .woodpecker/build-binary.yml create mode 100644 .woodpecker/build-container.yml create mode 100644 .woodpecker/docs.yml create mode 100644 .woodpecker/notify.yml create mode 100644 .woodpecker/test.yml rename Dockerfile.multiarch => Containerfile.multiarch (74%) delete mode 100644 cmd/drone-matrix/main.go rename cmd/{drone-matrix => wp-matrix}/config.go (80%) create mode 100644 cmd/wp-matrix/main.go diff --git a/.chglog/config.yml b/.chglog/config.yml index 691846c..0c606be 100755 --- a/.chglog/config.yml +++ b/.chglog/config.yml @@ -2,7 +2,7 @@ style: github template: CHANGELOG.tpl.md info: title: CHANGELOG - repository_url: https://github.com/thegeeklab/drone-matrix + repository_url: https://github.com/thegeeklab/wp-matrix options: commit_groups: title_maps: diff --git a/.drone.yml b/.drone.yml deleted file mode 100644 index 2d7d9cf..0000000 --- a/.drone.yml +++ /dev/null @@ -1,297 +0,0 @@ ---- -kind: pipeline -name: test - -platform: - os: linux - arch: amd64 - -steps: - - name: deps - image: golang:1.20 - commands: - - make deps - volumes: - - name: godeps - path: /go - - - name: lint - image: golang:1.20 - commands: - - make lint - volumes: - - name: godeps - path: /go - - - name: test - image: golang:1.20 - commands: - - make test - volumes: - - name: godeps - path: /go - -volumes: - - name: godeps - temp: {} - -trigger: - ref: - - refs/heads/main - - refs/tags/** - - refs/pull/** - ---- -kind: pipeline -name: build-binaries - -platform: - os: linux - arch: amd64 - -steps: - - name: build - image: techknowlogick/xgo:go-1.20.x - commands: - - ln -s /drone/src /source - - make release - - - name: executable - image: alpine - commands: - - $(find dist/ -executable -type f -iname ${DRONE_REPO_NAME}-linux-amd64) --help - - - name: changelog-generate - image: thegeeklab/git-chglog - commands: - - git fetch -tq - - git-chglog --no-color --no-emoji -o CHANGELOG.md ${DRONE_TAG:---next-tag unreleased unreleased} - - - name: changelog-format - image: thegeeklab/alpine-tools - commands: - - prettier CHANGELOG.md - - prettier -w CHANGELOG.md - - - name: publish - image: plugins/github-release - settings: - api_key: - from_secret: github_token - files: - - dist/* - note: CHANGELOG.md - overwrite: true - title: ${DRONE_TAG} - when: - ref: - - refs/tags/** - -trigger: - ref: - - refs/heads/main - - refs/tags/** - - refs/pull/** - -depends_on: - - test - ---- -kind: pipeline -name: build-container - -platform: - os: linux - arch: amd64 - -steps: - - name: dryrun - image: thegeeklab/drone-docker-buildx:23 - settings: - dockerfile: Dockerfile.multiarch - dry_run: true - platforms: - - linux/amd64 - - linux/arm64 - - linux/arm/v7 - - linux/arm/v6 - provenance: false - repo: thegeeklab/${DRONE_REPO_NAME} - when: - ref: - - refs/pull/** - - - name: publish-dockerhub - image: thegeeklab/drone-docker-buildx:23 - settings: - auto_tag: true - dockerfile: Dockerfile.multiarch - password: - from_secret: docker_password - platforms: - - linux/amd64 - - linux/arm64 - - linux/arm/v7 - - linux/arm/v6 - provenance: false - repo: thegeeklab/${DRONE_REPO_NAME} - username: - from_secret: docker_username - when: - ref: - - refs/heads/main - - refs/tags/** - depends_on: - - dryrun - - - name: publish-quay - image: thegeeklab/drone-docker-buildx:23 - settings: - auto_tag: true - dockerfile: Dockerfile.multiarch - password: - from_secret: quay_password - platforms: - - linux/amd64 - - linux/arm64 - - linux/arm/v7 - - linux/arm/v6 - provenance: false - registry: quay.io - repo: quay.io/thegeeklab/${DRONE_REPO_NAME} - username: - from_secret: quay_username - when: - ref: - - refs/heads/main - - refs/tags/** - depends_on: - - dryrun - -trigger: - ref: - - refs/heads/main - - refs/tags/** - - refs/pull/** - -depends_on: - - test - ---- -kind: pipeline -name: docs - -platform: - os: linux - arch: amd64 - -concurrency: - limit: 1 - -steps: - - name: markdownlint - image: thegeeklab/markdownlint-cli - commands: - - markdownlint 'docs/content/**/*.md' 'README.md' 'CONTRIBUTING.md' - - - name: spellcheck - image: thegeeklab/alpine-tools - commands: - - spellchecker --files '_docs/**/*.md' 'README.md' 'CONTRIBUTING.md' -d .dictionary -p spell indefinite-article syntax-urls --no-suggestions - environment: - FORCE_COLOR: true - NPM_CONFIG_LOGLEVEL: error - - - name: publish - image: thegeeklab/drone-git-action - settings: - action: - - pages - author_email: bot@thegeeklab.de - author_name: thegeeklab-bot - branch: docs - message: auto-update documentation - netrc_password: - from_secret: github_token - pages_directory: _docs/ - when: - ref: - - refs/heads/main - -trigger: - ref: - - refs/heads/main - - refs/tags/** - - refs/pull/** - -depends_on: - - build-binaries - - build-container - ---- -kind: pipeline -name: notifications - -platform: - os: linux - arch: amd64 - -steps: - - name: pushrm-dockerhub - image: chko/docker-pushrm:1 - environment: - DOCKER_PASS: - from_secret: docker_password - DOCKER_USER: - from_secret: docker_username - PUSHRM_FILE: README.md - PUSHRM_SHORT: Drone plugin to to send messages to Matrix - PUSHRM_TARGET: thegeeklab/${DRONE_REPO_NAME} - when: - status: - - success - - - name: pushrm-quay - image: chko/docker-pushrm:1 - environment: - APIKEY__QUAY_IO: - from_secret: quay_token - PUSHRM_FILE: README.md - PUSHRM_TARGET: quay.io/thegeeklab/${DRONE_REPO_NAME} - when: - status: - - success - - - name: matrix - image: thegeeklab/drone-matrix - settings: - homeserver: - from_secret: matrix_homeserver - password: - from_secret: matrix_password - roomid: - from_secret: matrix_roomid - template: "Status: **{{ .Build.Status }}**
Build: [{{ .Repo.Owner }}/{{ .Repo.Name }}]({{ .Build.Link }}){{ if .Build.Branch }} ({{ .Build.Branch }}){{ end }} by {{ .Commit.Author }}
Message: {{ .Commit.Message.Title }}" - username: - from_secret: matrix_username - when: - status: - - success - - failure - -trigger: - ref: - - refs/heads/main - - refs/tags/** - status: - - success - - failure - -depends_on: - - docs - ---- -kind: signature -hmac: b1a61f7bdf20a71610d4c1bb8f641bdb13503a40413288ff07bf77f51ae0914b - -... diff --git a/.github/settings.yml b/.github/settings.yml index b5ae1c5..2ef6dc9 100644 --- a/.github/settings.yml +++ b/.github/settings.yml @@ -1,8 +1,8 @@ repository: - name: drone-matrix - description: Drone plugin to to send messages to Matrix - homepage: https://drone-plugin-index.geekdocs.de/plugins/drone-matrix - topics: drone, drone-plugin + name: wp-matrix + description: Woodpecker CI plugin to send messages to Matrix + homepage: https://wp-plugin-index.geekdocs.de/plugins/wp-matrix + topics: woodpecker-ci, woodpecker, woodpecker-plugin private: false has_issues: true @@ -51,8 +51,11 @@ branches: required_status_checks: strict: false contexts: - - continuous-integration/drone/pr - enforce_admins: true + - ci/woodpecker/pr/test + - ci/woodpecker/pr/build-binary + - ci/woodpecker/pr/build-container + - ci/woodpecker/pr/docs + enforce_admins: false required_linear_history: true restrictions: null - name: docs diff --git a/.gitignore b/.gitignore index 50e1edc..ec1d1cc 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,6 @@ /dist/ /release/ -/drone-matrix* +/wp-matrix* coverage.out CHANGELOG.md diff --git a/.prettierignore b/.prettierignore index 23a4f05..135c35d 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,3 +1,2 @@ -.drone.yml *.tpl.md LICENSE diff --git a/.woodpecker/build-binary.yml b/.woodpecker/build-binary.yml new file mode 100644 index 0000000..21ee508 --- /dev/null +++ b/.woodpecker/build-binary.yml @@ -0,0 +1,44 @@ +--- +when: + - event: [pull_request, tag] + - event: [push, manual] + branch: + - ${CI_REPO_DEFAULT_BRANCH} + +steps: + build: + image: docker.io/techknowlogick/xgo:go-1.20.x + commands: + - ln -s $(pwd) /source + - make release + + executable: + image: docker.io/library/alpine + commands: + - $(find dist/ -executable -type f -iname ${CI_REPO_NAME}-linux-amd64) --help + + changelog-generate: + image: quay.io/thegeeklab/git-chglog + commands: + - git fetch -tq + - git-chglog --no-color --no-emoji -o CHANGELOG.md ${CI_COMMIT_TAG:---next-tag unreleased unreleased} + + changelog-format: + image: quay.io/thegeeklab/alpine-tools + commands: + - prettier CHANGELOG.md + - prettier -w CHANGELOG.md + + publish-github: + image: docker.io/plugins/github-release + settings: + api_key: + from_secret: github_token + note: CHANGELOG.md + overwrite: true + title: ${CI_COMMIT_TAG} + when: + - event: [tag] + +depends_on: + - test diff --git a/.woodpecker/build-container.yml b/.woodpecker/build-container.yml new file mode 100644 index 0000000..8f39dab --- /dev/null +++ b/.woodpecker/build-container.yml @@ -0,0 +1,66 @@ +--- +when: + - event: [pull_request, tag] + - event: [push, manual] + branch: + - ${CI_REPO_DEFAULT_BRANCH} + +steps: + dryrun: + image: quay.io/thegeeklab/wp-docker-buildx + settings: + containerfile: Containerfile.multiarch + dry_run: true + platforms: + - linux/amd64 + - linux/arm64 + provenance: false + repo: ${CI_REPO} + when: + - event: [pull_request] + + publish-dockerhub: + group: container + image: quay.io/thegeeklab/wp-docker-buildx + settings: + auto_tag: true + containerfile: Containerfile.multiarch + password: + from_secret: docker_password + platforms: + - linux/amd64 + - linux/arm64 + provenance: false + repo: ${CI_REPO} + username: + from_secret: docker_username + when: + - event: [tag] + - event: [push, manual] + branch: + - ${CI_REPO_DEFAULT_BRANCH} + + publish-quay: + group: container + image: quay.io/thegeeklab/wp-docker-buildx + settings: + auto_tag: true + containerfile: Containerfile.multiarch + password: + from_secret: quay_password + platforms: + - linux/amd64 + - linux/arm64 + provenance: false + registry: quay.io + repo: quay.io/${CI_REPO} + username: + from_secret: quay_username + when: + - event: [tag] + - event: [push, manual] + branch: + - ${CI_REPO_DEFAULT_BRANCH} + +depends_on: + - test diff --git a/.woodpecker/docs.yml b/.woodpecker/docs.yml new file mode 100644 index 0000000..01a7d28 --- /dev/null +++ b/.woodpecker/docs.yml @@ -0,0 +1,72 @@ +--- +when: + - event: [pull_request, tag] + - event: [push, manual] + branch: + - ${CI_REPO_DEFAULT_BRANCH} + +steps: + markdownlint: + image: quay.io/thegeeklab/markdownlint-cli + commands: + - markdownlint 'README.md' 'CONTRIBUTING.md' + + spellcheck: + image: quay.io/thegeeklab/alpine-tools + commands: + - spellchecker --files '_docs/**/*.md' 'README.md' 'CONTRIBUTING.md' -d .dictionary -p spell indefinite-article syntax-urls --no-suggestions + environment: + FORCE_COLOR: "true" + NPM_CONFIG_LOGLEVEL: "error" + + publish: + image: quay.io/thegeeklab/wp-git-action + settings: + action: + - pages + author_email: bot@thegeeklab.de + author_name: thegeeklab-bot + branch: docs + message: "[skip ci] auto-update documentation" + netrc_password: + from_secret: github_token + pages_directory: _docs/ + when: + - event: [push, manual] + branch: + - ${CI_REPO_DEFAULT_BRANCH} + + pushrm-dockerhub: + image: docker.io/chko/docker-pushrm:1 + secrets: + - source: docker_password + target: DOCKER_PASS + - source: docker_username + target: DOCKER_USER + environment: + PUSHRM_FILE: README.md + PUSHRM_SHORT: Woodpecker CI plugin to send messages to Matrix + PUSHRM_TARGET: ${CI_REPO} + when: + - event: [push, manual] + branch: + - ${CI_REPO_DEFAULT_BRANCH} + status: [success] + + pushrm-quay: + image: docker.io/chko/docker-pushrm:1 + secrets: + - source: quay_token + target: APIKEY__QUAY_IO + environment: + PUSHRM_FILE: README.md + PUSHRM_TARGET: quay.io/${CI_REPO} + when: + - event: [push, manual] + branch: + - ${CI_REPO_DEFAULT_BRANCH} + status: [success] + +depends_on: + - build-binary + - build-container diff --git a/.woodpecker/notify.yml b/.woodpecker/notify.yml new file mode 100644 index 0000000..9028f78 --- /dev/null +++ b/.woodpecker/notify.yml @@ -0,0 +1,30 @@ +--- +when: + - event: [tag] + - event: [push, manual] + branch: + - ${CI_REPO_DEFAULT_BRANCH} + +runs_on: [success, failure] + +steps: + matrix: + image: quay.io/thegeeklab/drone-matrix + settings: + homeserver: + from_secret: matrix_homeserver + password: + from_secret: matrix_password + roomid: + from_secret: matrix_roomid + template: >- + Status: **{{ .Build.Status }}**
+ Build: [{{ .Repo.Owner }}/{{ .Repo.Name }}]({{ .Build.Link }}){{ if .Build.Branch }} ({{ .Build.Branch }}){{ end }} by {{ .Commit.Author }}
+ Message: {{ .Commit.Message.Title }} + username: + from_secret: matrix_username + when: + - status: [success, failure] + +depends_on: + - docs diff --git a/.woodpecker/test.yml b/.woodpecker/test.yml new file mode 100644 index 0000000..01952de --- /dev/null +++ b/.woodpecker/test.yml @@ -0,0 +1,22 @@ +--- +when: + - event: [pull_request, tag] + - event: [push, manual] + branch: + - ${CI_REPO_DEFAULT_BRANCH} + +steps: + deps: + image: docker.io/library/golang:1.20 + commands: + - make deps + + lint: + image: docker.io/library/golang:1.20 + commands: + - make lint + + test: + image: docker.io/library/golang:1.20 + commands: + - make test diff --git a/Dockerfile.multiarch b/Containerfile.multiarch similarity index 74% rename from Dockerfile.multiarch rename to Containerfile.multiarch index 868db33..2472f3c 100644 --- a/Dockerfile.multiarch +++ b/Containerfile.multiarch @@ -12,10 +12,10 @@ FROM alpine:3.18@sha256:7144f7bab3d4c2648d7e59409f15ec52a18006a128c733fcff20d3a4 LABEL maintainer="Robert Kaussow " LABEL org.opencontainers.image.authors="Robert Kaussow " -LABEL org.opencontainers.image.title="drone-matrix" -LABEL org.opencontainers.image.url="https://github.com/thegeeklab/drone-matrix" -LABEL org.opencontainers.image.source="https://github.com/thegeeklab/drone-matrix" -LABEL org.opencontainers.image.documentation="https://github.com/thegeeklab/drone-matrix" +LABEL org.opencontainers.image.title="wp-matrix" +LABEL org.opencontainers.image.url="https://github.com/thegeeklab/wp-matrix" +LABEL org.opencontainers.image.source="https://github.com/thegeeklab/wp-matrix" +LABEL org.opencontainers.image.documentation="https://github.com/thegeeklab/wp-matrix" -COPY --from=build /src/dist/drone-matrix /bin/drone-matrix -ENTRYPOINT [ "/bin/drone-matrix" ] +COPY --from=build /src/dist/wp-matrix /bin/wp-matrix +ENTRYPOINT [ "/bin/wp-matrix" ] diff --git a/Makefile b/Makefile index c62c986..0cbb59e 100644 --- a/Makefile +++ b/Makefile @@ -3,7 +3,7 @@ GOFUMPT_PACKAGE_VERSION := v0.5.0 # renovate: datasource=github-releases depName=golangci/golangci-lint GOLANGCI_LINT_PACKAGE_VERSION := v1.53.3 -EXECUTABLE := drone-matrix +EXECUTABLE := wp-matrix DIST := dist DIST_DIRS := $(DIST) @@ -30,8 +30,8 @@ endif TAGS ?= netgo ifndef VERSION - ifneq ($(DRONE_TAG),) - VERSION ?= $(subst v,,$(DRONE_TAG)) + ifneq ($(CI_COMMIT_TAG),) + VERSION ?= $(subst v,,$(CI_COMMIT_TAG)) else VERSION ?= $(shell git rev-parse --short HEAD) endif diff --git a/README.md b/README.md index 63c973f..4c210be 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,21 @@ -# drone-matrix +# wp-matrix -Drone plugin to to send messages to Matrix +Woodpecker CI plugin to send messages to Matrix -[![Build Status](https://img.shields.io/drone/build/thegeeklab/drone-matrix?logo=drone&server=https%3A%2F%2Fdrone.thegeeklab.de)](https://drone.thegeeklab.de/thegeeklab/drone-matrix) -[![Docker Hub](https://img.shields.io/badge/dockerhub-latest-blue.svg?logo=docker&logoColor=white)](https://hub.docker.com/r/thegeeklab/drone-matrix) -[![Quay.io](https://img.shields.io/badge/quay-latest-blue.svg?logo=docker&logoColor=white)](https://quay.io/repository/thegeeklab/drone-matrix) -[![Go Report Card](https://goreportcard.com/badge/github.com/thegeeklab/drone-matrix)](https://goreportcard.com/report/github.com/thegeeklab/drone-matrix) -[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/drone-matrix)](https://github.com/thegeeklab/drone-matrix/graphs/contributors) -[![Source: GitHub](https://img.shields.io/badge/source-github-blue.svg?logo=github&logoColor=white)](https://github.com/thegeeklab/drone-matrix) -[![License: Apache-2.0](https://img.shields.io/github/license/thegeeklab/drone-matrix)](https://github.com/thegeeklab/drone-matrix/blob/main/LICENSE) +[![Build Status](https://ci.thegeeklab.de/api/badges/thegeeklab/wp-matrix/status.svg)](https://ci.thegeeklab.de/repos/thegeeklab/wp-matrix) +[![Docker Hub](https://img.shields.io/badge/dockerhub-latest-blue.svg?logo=docker&logoColor=white)](https://hub.docker.com/r/thegeeklab/wp-matrix) +[![Quay.io](https://img.shields.io/badge/quay-latest-blue.svg?logo=docker&logoColor=white)](https://quay.io/repository/thegeeklab/wp-matrix) +[![Go Report Card](https://goreportcard.com/badge/github.com/thegeeklab/wp-matrix)](https://goreportcard.com/report/github.com/thegeeklab/wp-matrix) +[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/wp-matrix)](https://github.com/thegeeklab/wp-matrix/graphs/contributors) +[![Source: GitHub](https://img.shields.io/badge/source-github-blue.svg?logo=github&logoColor=white)](https://github.com/thegeeklab/wp-matrix) +[![License: Apache-2.0](https://img.shields.io/github/license/thegeeklab/wp-matrix)](https://github.com/thegeeklab/wp-matrix/blob/main/LICENSE) -Drone plugin to to send messages to a Matrix room. You can find the full documentation at [https://drone-plugin-index.geekdocs.de](https://drone-plugin-index.geekdocs.de/plugins/drone-matrix). +Woodpecker CI plugin to send messages to a Matrix room. You can find the full documentation at [https://wp-plugin-index.geekdocs.de](https://wp-plugin-index.geekdocs.de/plugins/wp-matrix). ## Contributors -Special thanks to all [contributors](https://github.com/thegeeklab/drone-matrix/graphs/contributors). If you would like to contribute, please see the [instructions](https://github.com/thegeeklab/drone-matrix/blob/main/CONTRIBUTING.md). +Special thanks to all [contributors](https://github.com/thegeeklab/wp-matrix/graphs/contributors). If you would like to contribute, please see the [instructions](https://github.com/thegeeklab/wp-matrix/blob/main/CONTRIBUTING.md). ## License -This project is licensed under the Apache-2.0 License - see the [LICENSE](https://github.com/thegeeklab/drone-matrix/blob/main/LICENSE) file for details. +This project is licensed under the Apache-2.0 License - see the [LICENSE](https://github.com/thegeeklab/wp-matrix/blob/main/LICENSE) file for details. diff --git a/_docs/content/_index.md b/_docs/content/_index.md index 8659eb9..026dc07 100644 --- a/_docs/content/_index.md +++ b/_docs/content/_index.md @@ -1,15 +1,16 @@ --- -title: drone-matrix +title: wp-matrix --- -[![Build Status](https://img.shields.io/drone/build/thegeeklab/drone-matrix?logo=drone&server=https%3A%2F%2Fdrone.thegeeklab.de)](https://drone.thegeeklab.de/thegeeklab/drone-matrix) -[![Docker Hub](https://img.shields.io/badge/dockerhub-latest-blue.svg?logo=docker&logoColor=white)](https://hub.docker.com/r/thegeeklab/drone-matrix) -[![Quay.io](https://img.shields.io/badge/quay-latest-blue.svg?logo=docker&logoColor=white)](https://quay.io/repository/thegeeklab/drone-matrix) -[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/drone-matrix)](https://github.com/thegeeklab/drone-matrix/graphs/contributors) -[![Source: GitHub](https://img.shields.io/badge/source-github-blue.svg?logo=github&logoColor=white)](https://github.com/thegeeklab/drone-matrix) -[![License: MIT](https://img.shields.io/github/license/thegeeklab/drone-matrix)](https://github.com/thegeeklab/drone-matrix/blob/main/LICENSE) +[![Build Status](https://ci.thegeeklab.de/api/badges/thegeeklab/wp-matrix/status.svg)](https://ci.thegeeklab.de/repos/thegeeklab/wp-matrix) +[![Docker Hub](https://img.shields.io/badge/dockerhub-latest-blue.svg?logo=docker&logoColor=white)](https://hub.docker.com/r/thegeeklab/wp-matrix) +[![Quay.io](https://img.shields.io/badge/quay-latest-blue.svg?logo=docker&logoColor=white)](https://quay.io/repository/thegeeklab/wp-matrix) +[![Go Report Card](https://goreportcard.com/badge/github.com/thegeeklab/wp-matrix)](https://goreportcard.com/report/github.com/thegeeklab/wp-matrix) +[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/wp-matrix)](https://github.com/thegeeklab/wp-matrix/graphs/contributors) +[![Source: GitHub](https://img.shields.io/badge/source-github-blue.svg?logo=github&logoColor=white)](https://github.com/thegeeklab/wp-matrix) +[![License: Apache-2.0](https://img.shields.io/github/license/thegeeklab/wp-matrix)](https://github.com/thegeeklab/wp-matrix/blob/main/LICENSE) -Drone plugin to to send messages to a Matrix room. +Woodpecker CI plugin to send messages to a Matrix room. @@ -37,7 +38,7 @@ steps: -{{< propertylist name=drone-matrix.data sort=name >}} +{{< propertylist name=wp-matrix.data sort=name >}} @@ -46,18 +47,13 @@ steps: Build the binary with the following command: ```Shell -export GOOS=linux -export GOARCH=amd64 -export CGO_ENABLED=0 -export GO111MODULE=on - make build ``` -Build the Docker image with the following command: +Build the container image with the following command: ```Shell -docker build --file docker/Dockerfile.amd64 --tag thegeeklab/drone-matrix . +docker build --file Containerfile.multiarch --tag thegeeklab/wp-matrix . ``` ## Test @@ -67,7 +63,7 @@ docker run --rm \ -e PLUGIN_ROOMID=0123456789abcdef:matrix.org \ -e PLUGIN_USERNAME=yourbot \ -e PLUGIN_PASSWORD=p455w0rd \ - -v $(pwd):$(pwd) \ - -w $(pwd) \ - thegeeklab/drone-matrix + -v $(pwd):/build:z \ + -w /build \ + thegeeklab/wp-matrix ``` diff --git a/_docs/data/data.yaml b/_docs/data/data.yaml index 8e47ff7..ee9b70c 100644 --- a/_docs/data/data.yaml +++ b/_docs/data/data.yaml @@ -33,8 +33,11 @@ properties: - name: template description: | - Golang template for the message. The [pipeline struct](https://pkg.go.dev/github.com/thegeeklab/drone-plugin-lib/v2/drone#Pipeline) + Golang template for the message. The [Metadata struct](https://pkg.go.dev/github.com/thegeeklab/wp-plugin-go/plugin#Metadata) is exposed to the template and all fields can be referenced. To extend the functionality, [sprig functions](https://masterminds.github.io/sprig/) can also be used. - defaultValue: "Build {{ .Build.Status }} [{{ .Repo.Owner }}/{{ .Repo.Name }}#{{ trunc 8 .Commit.SHA }}]({{ .Build.Link }}) ({{ .Build.Branch }}) by {{ .Commit.Author }}" + defaultValue: | + Status: **{{ .Pipeline.Status }}**
+ Build: [{{ .Repository.Owner }}/{{ .Repository.Name }}]({{ .Repository.Link }}){{ if .Repository.Branch }} ({{ .Repository.Branch }}){{ end }} by {{ .Commit.Author }}
+ Message: {{ .Commit.Message }} type: string required: false diff --git a/cmd/drone-matrix/main.go b/cmd/drone-matrix/main.go deleted file mode 100644 index d2aded4..0000000 --- a/cmd/drone-matrix/main.go +++ /dev/null @@ -1,70 +0,0 @@ -// Copyright (c) 2020, the Drone Plugins project authors. -// Copyright (c) 2021, Robert Kaussow - -// Use of this source code is governed by an Apache 2.0 license that can be -// found in the LICENSE file. - -package main - -import ( - "fmt" - "os" - - "github.com/drone-plugins/drone-matrix/plugin" - "github.com/joho/godotenv" - "github.com/sirupsen/logrus" - "github.com/thegeeklab/drone-plugin-lib/v2/urfave" - "github.com/urfave/cli/v2" -) - -//nolint:gochecknoglobals -var ( - BuildVersion = "devel" - BuildDate = "00000000" -) - -func main() { - settings := &plugin.Settings{} - - if _, err := os.Stat("/run/drone/env"); err == nil { - _ = godotenv.Overload("/run/drone/env") - } - - cli.VersionPrinter = func(c *cli.Context) { - fmt.Printf("%s version=%s date=%s\n", c.App.Name, c.App.Version, BuildDate) - } - - app := &cli.App{ - Name: "drone-matrix", - Usage: "build notifications for matrix", - Version: BuildVersion, - Flags: append(settingsFlags(settings, urfave.FlagsPluginCategory), urfave.Flags()...), - Action: run(settings), - } - - if err := app.Run(os.Args); err != nil { - logrus.Fatal(err) - } -} - -func run(settings *plugin.Settings) cli.ActionFunc { - return func(ctx *cli.Context) error { - urfave.LoggingFromContext(ctx) - - plugin := plugin.New( - *settings, - urfave.PipelineFromContext(ctx), - urfave.NetworkFromContext(ctx), - ) - - if err := plugin.Validate(); err != nil { - return fmt.Errorf("validation failed: %w", err) - } - - if err := plugin.Execute(); err != nil { - return fmt.Errorf("execution failed: %w", err) - } - - return nil - } -} diff --git a/cmd/drone-matrix/config.go b/cmd/wp-matrix/config.go similarity index 80% rename from cmd/drone-matrix/config.go rename to cmd/wp-matrix/config.go index 6f3d6aa..9fa0155 100644 --- a/cmd/drone-matrix/config.go +++ b/cmd/wp-matrix/config.go @@ -7,10 +7,17 @@ package main import ( - "github.com/drone-plugins/drone-matrix/plugin" + "github.com/thegeeklab/wp-matrix/plugin" "github.com/urfave/cli/v2" ) +//nolint:lll +const defaultTemplate = ` +Status: **{{ .Pipeline.Status }}**
+Build: [{{ .Repository.Owner }}/{{ .Repository.Name }}]({{ .Repository.Link }}){{ if .Curr.TargetBranch }} ({{ .Curr.TargetBranch }}){{ end }} by {{ .Curr.Author }}
+Message: {{ .Curr.Message }} +` + // settingsFlags has the cli.Flags for the plugin.Settings. func settingsFlags(settings *plugin.Settings, category string) []cli.Flag { return []cli.Flag{ @@ -58,11 +65,10 @@ func settingsFlags(settings *plugin.Settings, category string) []cli.Flag { Category: category, }, &cli.StringFlag{ - Name: "template", - EnvVars: []string{"PLUGIN_TEMPLATE", "MATRIX_TEMPLATE"}, - Usage: "message template", - //nolint:lll - Value: "Build {{ .Build.Status }} [{{ .Repo.Owner }}/{{ .Repo.Name }}#{{ trunc 8 .Commit.SHA }}]({{ .Build.Link }}) ({{ .Build.Branch }}) by {{ .Commit.Author }}", + Name: "template", + EnvVars: []string{"PLUGIN_TEMPLATE", "MATRIX_TEMPLATE"}, + Usage: "message template", + Value: defaultTemplate, Destination: &settings.Template, Category: category, }, diff --git a/cmd/wp-matrix/main.go b/cmd/wp-matrix/main.go new file mode 100644 index 0000000..a7b897e --- /dev/null +++ b/cmd/wp-matrix/main.go @@ -0,0 +1,34 @@ +// Copyright (c) 2020, the Drone Plugins project authors. +// Copyright (c) 2021, Robert Kaussow + +// Use of this source code is governed by an Apache 2.0 license that can be +// found in the LICENSE file. + +package main + +import ( + "fmt" + + "github.com/thegeeklab/wp-matrix/plugin" + + wp "github.com/thegeeklab/wp-plugin-go/plugin" +) + +//nolint:gochecknoglobals +var ( + BuildVersion = "devel" + BuildDate = "00000000" +) + +func main() { + settings := &plugin.Settings{} + options := wp.Options{ + Name: "wp-matrix", + Description: "Send messages to a Matrix room", + Version: BuildVersion, + VersionMetadata: fmt.Sprintf("date=%s", BuildDate), + Flags: settingsFlags(settings, wp.FlagsPluginCategory), + } + + plugin.New(options, settings).Run() +} diff --git a/go.mod b/go.mod index bc7d69e..7928565 100644 --- a/go.mod +++ b/go.mod @@ -1,15 +1,14 @@ -module github.com/drone-plugins/drone-matrix +module github.com/thegeeklab/wp-matrix go 1.20 require ( - github.com/joho/godotenv v1.5.1 github.com/matrix-org/gomatrix v0.0.0-20220926102614-ceba4d9f7530 github.com/microcosm-cc/bluemonday v1.0.25 + github.com/rs/zerolog v1.30.0 github.com/russross/blackfriday/v2 v2.1.0 - github.com/sirupsen/logrus v1.9.3 - github.com/thegeeklab/drone-plugin-lib/v2 v2.3.4 - github.com/urfave/cli/v2 v2.25.5 + github.com/thegeeklab/wp-plugin-go v0.2.0 + github.com/urfave/cli/v2 v2.25.7 maunium.net/go/mautrix v0.15.4 ) @@ -23,11 +22,11 @@ require ( github.com/gorilla/css v1.0.0 // indirect github.com/huandu/xstrings v1.3.3 // indirect github.com/imdario/mergo v0.3.12 // indirect + github.com/joho/godotenv v1.5.1 // indirect github.com/mattn/go-colorable v0.1.12 // indirect github.com/mattn/go-isatty v0.0.14 // indirect github.com/mitchellh/copystructure v1.2.0 // indirect github.com/mitchellh/reflectwalk v1.0.2 // indirect - github.com/rs/zerolog v1.29.1 // indirect github.com/shopspring/decimal v1.3.1 // indirect github.com/spf13/cast v1.4.1 // indirect github.com/tidwall/gjson v1.14.4 // indirect @@ -35,10 +34,10 @@ require ( github.com/tidwall/pretty v1.2.0 // indirect github.com/tidwall/sjson v1.2.5 // indirect github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 // indirect - golang.org/x/crypto v0.11.0 // indirect + golang.org/x/crypto v0.12.0 // indirect golang.org/x/exp v0.0.0-20230713183714-613f0c0eb8a1 // indirect - golang.org/x/net v0.12.0 // indirect - golang.org/x/sys v0.10.0 // indirect + golang.org/x/net v0.14.0 // indirect + golang.org/x/sys v0.11.0 // indirect gopkg.in/yaml.v2 v2.4.0 // indirect maunium.net/go/maulogger/v2 v2.4.1 // indirect ) diff --git a/go.sum b/go.sum index db93cdc..c626d14 100644 --- a/go.sum +++ b/go.sum @@ -42,26 +42,23 @@ github.com/mitchellh/reflectwalk v1.0.2/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= -github.com/rs/xid v1.4.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg= -github.com/rs/zerolog v1.29.1 h1:cO+d60CHkknCbvzEWxP0S9K6KqyTjrCNUy1LdQLCGPc= -github.com/rs/zerolog v1.29.1/go.mod h1:Le6ESbR7hc+DP6Lt1THiV8CQSdkkNrd3R0XbEgp3ZBU= +github.com/rs/xid v1.5.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg= +github.com/rs/zerolog v1.30.0 h1:SymVODrcRsaRaSInD9yQtKbtWqwsfoPcRff/oRXLj4c= +github.com/rs/zerolog v1.30.0/go.mod h1:/tk+P47gFdPXq4QYjvCmT5/Gsug2nagsFWBWhAiSi1w= github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk= github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/shopspring/decimal v1.2.0/go.mod h1:DKyhrW/HYNuLGql+MJL6WCR6knT2jwCFRcu2hWCYk4o= github.com/shopspring/decimal v1.3.1 h1:2Usl1nmF/WZucqkFZhnfFYxxxu8LG21F6nPQBE5gKV8= github.com/shopspring/decimal v1.3.1/go.mod h1:DKyhrW/HYNuLGql+MJL6WCR6knT2jwCFRcu2hWCYk4o= -github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ= -github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ= github.com/spf13/cast v1.3.1/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE= github.com/spf13/cast v1.4.1 h1:s0hze+J0196ZfEMTs80N7UlFt0BDuQ7Q+JDnHiMWKdA= github.com/spf13/cast v1.4.1/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA= -github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk= -github.com/thegeeklab/drone-plugin-lib/v2 v2.3.4 h1:Quzrike/xRAR0izxQ0d+ocJyIUm4h1497Oyo9grcRzg= -github.com/thegeeklab/drone-plugin-lib/v2 v2.3.4/go.mod h1:qWVUZCmwL0Ntwa/hvyqM03EeIr1ReBR2XJsmIc7MGus= +github.com/thegeeklab/wp-plugin-go v0.2.0 h1:uQzyCNUS2CthdtL5OssprhFKxJoGVyuEXMUNsrKW5Qs= +github.com/thegeeklab/wp-plugin-go v0.2.0/go.mod h1:7PWAZiTnZ2fAvjsedopQJ6w873KuSxUWsAml1Yib8a0= github.com/tidwall/gjson v1.14.2/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk= github.com/tidwall/gjson v1.14.4 h1:uo0p8EbA09J7RQaflQ1aBRffTR7xedD2bcIVSYxLnkM= github.com/tidwall/gjson v1.14.4/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk= @@ -71,16 +68,16 @@ github.com/tidwall/pretty v1.2.0 h1:RWIZEg2iJ8/g6fDDYzMpobmaoGh5OLl4AXtGUGPcqCs= github.com/tidwall/pretty v1.2.0/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU= github.com/tidwall/sjson v1.2.5 h1:kLy8mja+1c9jlljvWTlSazM7cKDRfJuR/bOJhcY5NcY= github.com/tidwall/sjson v1.2.5/go.mod h1:Fvgq9kS/6ociJEDnK0Fk1cpYF4FIW6ZF7LAe+6jwd28= -github.com/urfave/cli/v2 v2.25.5 h1:d0NIAyhh5shGscroL7ek/Ya9QYQE0KNabJgiUinIQkc= -github.com/urfave/cli/v2 v2.25.5/go.mod h1:GHupkWPMM0M/sj1a2b4wUrWBPzazNrIjouW6fmdJLxc= +github.com/urfave/cli/v2 v2.25.7 h1:VAzn5oq403l5pHjc4OhD54+XGO9cdKVL/7lDjF+iKUs= +github.com/urfave/cli/v2 v2.25.7/go.mod h1:8qnjx1vcq5s2/wpsqoZFndg2CE5tNFyrTvS6SinrnYQ= github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 h1:bAn7/zixMGCfxrRTfdpNzjtPYqr8smhKouy9mxVdGPU= github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673/go.mod h1:N3UwUGtsrSj3ccvlPHLoLsHnpR27oXr4ZE984MbSER8= github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/crypto v0.3.0/go.mod h1:hebNnKkNXi2UzZN1eVRvBB7co0a+JxK6XbPiWVs/3J4= -golang.org/x/crypto v0.11.0 h1:6Ewdq3tDic1mg5xRO4milcWCfMVQhI4NkqWWvqejpuA= -golang.org/x/crypto v0.11.0/go.mod h1:xgJhtzW8F9jGdVFWZESrid1U1bjeNy4zgy5cRr/CIio= +golang.org/x/crypto v0.12.0 h1:tFM/ta59kqch6LlvYnPa0yx5a83cL2nHflFhYKvv9Yk= +golang.org/x/crypto v0.12.0/go.mod h1:NF0Gs7EO5K4qLn+Ylc+fih8BSTeIjAP05siRnAh98yw= golang.org/x/exp v0.0.0-20230713183714-613f0c0eb8a1 h1:MGwJjxBy0HJshjDNfLsYO8xppfqWlA5ZT9OhtUUhTNw= golang.org/x/exp v0.0.0-20230713183714-613f0c0eb8a1/go.mod h1:FXUEEKJgO7OQYeo8N01OfiKP8RXMtf6e8aTskBGqWdc= golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= @@ -88,8 +85,8 @@ golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLL golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= golang.org/x/net v0.2.0/go.mod h1:KqCZLdyyvdV855qA2rE3GC2aiw5xGR5TEjj8smXukLY= -golang.org/x/net v0.12.0 h1:cfawfvKITfUsFCeJIHJrbSxpeu/E81khclypR0GVT50= -golang.org/x/net v0.12.0/go.mod h1:zEVYFnQC7m/vmpQFELhcD1EWkZlX69l4oqgmer6hfKA= +golang.org/x/net v0.14.0 h1:BONx9s002vGdD9umnlX1Po8vOZmrgH34qlHcD1MfK14= +golang.org/x/net v0.14.0/go.mod h1:PpSgVXXLK0OxS0F31C1/tv6XNguvCrnXIDrFMspZIUI= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= @@ -98,11 +95,10 @@ golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBc golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.2.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.10.0 h1:SqMFp9UcQJZa+pmYuAKjd9xq1f0j5rLcDIk0mj4qAsA= -golang.org/x/sys v0.10.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.11.0 h1:eG7RXZHdqOJ1i+0lgLgCpSXAp6M3LYlAo6osgSi0xOM= +golang.org/x/sys v0.11.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= golang.org/x/term v0.2.0/go.mod h1:TVmDHMZPmdnySmBfhjOoOdhjzdE1h4u1VwSiw2l1Nuc= @@ -119,7 +115,6 @@ gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY= gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= -gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= maunium.net/go/maulogger/v2 v2.4.1 h1:N7zSdd0mZkB2m2JtFUsiGTQQAdP0YeFWT7YMc80yAL8= maunium.net/go/maulogger/v2 v2.4.1/go.mod h1:omPuYwYBILeVQobz8uO3XC8DIRuEb5rXYlQSuqrbCho= diff --git a/plugin/impl.go b/plugin/impl.go index 925d4b4..bd7d178 100644 --- a/plugin/impl.go +++ b/plugin/impl.go @@ -7,37 +7,43 @@ package plugin import ( + "context" "errors" "fmt" "strings" "github.com/matrix-org/gomatrix" "github.com/microcosm-cc/bluemonday" + "github.com/rs/zerolog/log" "github.com/russross/blackfriday/v2" - "github.com/sirupsen/logrus" - "github.com/thegeeklab/drone-plugin-lib/v2/template" + "github.com/thegeeklab/wp-plugin-go/template" + "github.com/urfave/cli/v2" "maunium.net/go/mautrix" "maunium.net/go/mautrix/event" "maunium.net/go/mautrix/id" ) -// Settings for the plugin. -type Settings struct { - Username string - Password string - UserID string - AccessToken string - Homeserver string - RoomID string - Template string -} - var ErrAuthSourceNotSet = errors.New("either username and password or userid and accesstoken are required") +// Execute provides the implementation of the plugin. +// +//nolint:revive +func (p *Plugin) run(ctx context.Context, cCtx *cli.Context) error { + if err := p.Validate(); err != nil { + return fmt.Errorf("validation failed: %w", err) + } + + if err := p.Execute(); err != nil { + return fmt.Errorf("execution failed: %w", err) + } + + return nil +} + // Validate handles the settings validation of the plugin. func (p *Plugin) Validate() error { - if (p.settings.Username == "" || p.settings.Password == "") && - (p.settings.UserID == "" || p.settings.AccessToken == "") { + if (p.Settings.Username == "" || p.Settings.Password == "") && + (p.Settings.UserID == "" || p.Settings.AccessToken == "") { return ErrAuthSourceNotSet } @@ -46,19 +52,19 @@ func (p *Plugin) Validate() error { // Execute provides the implementation of the plugin. func (p *Plugin) Execute() error { - muid := id.NewUserID(prepend("@", p.settings.UserID), p.settings.Homeserver) + muid := id.NewUserID(prepend("@", p.Settings.UserID), p.Settings.Homeserver) - client, err := mautrix.NewClient(p.settings.Homeserver, muid, p.settings.AccessToken) + client, err := mautrix.NewClient(p.Settings.Homeserver, muid, p.Settings.AccessToken) if err != nil { return fmt.Errorf("failed to initialize client: %w", err) } - if p.settings.UserID == "" || p.settings.AccessToken == "" { + if p.Settings.UserID == "" || p.Settings.AccessToken == "" { _, err := client.Login(&mautrix.ReqLogin{ Type: "m.login.password", - Identifier: mautrix.UserIdentifier{Type: mautrix.IdentifierTypeUser, User: p.settings.Username}, - Password: p.settings.Password, - InitialDeviceDisplayName: "Drone", + Identifier: mautrix.UserIdentifier{Type: mautrix.IdentifierTypeUser, User: p.Settings.Username}, + Password: p.Settings.Password, + InitialDeviceDisplayName: "Woodpecker CI", StoreCredentials: true, }) if err != nil { @@ -66,14 +72,14 @@ func (p *Plugin) Execute() error { } } - logrus.Info("logged in successfully") + log.Info().Msg("logged in successfully") - joined, err := client.JoinRoom(prepend("!", p.settings.RoomID), "", nil) + joined, err := client.JoinRoom(prepend("!", p.Settings.RoomID), "", nil) if err != nil { return fmt.Errorf("failed to join room: %w", err) } - message, err := template.RenderTrim(p.network.Context, *p.network.Client, p.settings.Template, p.pipeline) + message, err := template.RenderTrim(p.Network.Context, *p.Network.Client, p.Settings.Template, p.Metadata) if err != nil { return fmt.Errorf("failed to render template: %w", err) } @@ -93,7 +99,7 @@ func (p *Plugin) Execute() error { return fmt.Errorf("failed to submit message: %w", err) } - logrus.Info("message sent successfully") + log.Info().Msg("message sent successfully") return nil } diff --git a/plugin/plugin.go b/plugin/plugin.go index 68884c7..5e322cf 100644 --- a/plugin/plugin.go +++ b/plugin/plugin.go @@ -7,21 +7,33 @@ package plugin import ( - "github.com/thegeeklab/drone-plugin-lib/v2/drone" + wp "github.com/thegeeklab/wp-plugin-go/plugin" ) -// Plugin implements drone.Plugin to provide the plugin implementation. +// Plugin implements provide the plugin implementation. type Plugin struct { - settings Settings - pipeline drone.Pipeline - network drone.Network + *wp.Plugin + Settings *Settings } -// New initializes a plugin from the given Settings, Pipeline, and Network. -func New(settings Settings, pipeline drone.Pipeline, network drone.Network) *Plugin { - return &Plugin{ - settings: settings, - pipeline: pipeline, - network: network, - } +// Settings for the plugin. +type Settings struct { + Username string + Password string + UserID string + AccessToken string + Homeserver string + RoomID string + Template string +} + +func New(options wp.Options, settings *Settings) *Plugin { + p := &Plugin{} + + options.Execute = p.run + + p.Plugin = wp.New(options) + p.Settings = settings + + return p }