From 54e6e53ecb1b6657b8d7f27ed42cfaf0148f767a Mon Sep 17 00:00:00 2001 From: schulzp Date: Tue, 15 Sep 2020 21:43:17 +0200 Subject: [PATCH] move to github * use github actions * add APL 2.0 license --- .github/upload-github-release-asset.sh | 39 +++++ .github/workflows/maven-release.yml | 90 +++++++++++ .github/workflows/maven-verify.yml | 31 ++++ .gitlab-ci.yml | 67 --------- .mvn/settings.xml | 65 ++++++++ LICENSE.txt | 201 +++++++++++++++++++++++++ README.md | 48 ++++-- pom.xml | 80 ++++++---- release.sh | 12 ++ 9 files changed, 525 insertions(+), 108 deletions(-) create mode 100755 .github/upload-github-release-asset.sh create mode 100644 .github/workflows/maven-release.yml create mode 100644 .github/workflows/maven-verify.yml delete mode 100644 .gitlab-ci.yml create mode 100644 .mvn/settings.xml create mode 100644 LICENSE.txt create mode 100755 release.sh diff --git a/.github/upload-github-release-asset.sh b/.github/upload-github-release-asset.sh new file mode 100755 index 0000000..79bdddd --- /dev/null +++ b/.github/upload-github-release-asset.sh @@ -0,0 +1,39 @@ +#!/usr/bin/env bash +# +# Based on +# +# Author: Stefan Buck +# License: MIT +# https://gist.github.com/stefanbuck/ce788fee19ab6eb0b4447a85fc99f447 +# +# +# This script accepts the following parameters: +# +# * repo +# * id +# * filename +# +# Script to upload a release asset using the GitHub API v3. +# +# Example: +# +# upload-github-release-asset.sh id= repo= filename= +# + +# Check dependencies. +set -e +xargs=$(which gxargs || which xargs) + +# Validate settings. +[ "$TRACE" ] && set -x + +CONFIG=$@ + +for line in $CONFIG; do + eval "$line" +done + +# Construct url +UPLOAD_URL="https://uploads.github.com/repos/$repo/releases/$id/assets?name=$(basename $filename)" + +curl --data-binary @"$filename" -H "Authorization: token $GITHUB_TOKEN" -H "Content-Type: application/octet-stream" $UPLOAD_URL diff --git a/.github/workflows/maven-release.yml b/.github/workflows/maven-release.yml new file mode 100644 index 0000000..24d106b --- /dev/null +++ b/.github/workflows/maven-release.yml @@ -0,0 +1,90 @@ +name: Release + +on: + push: + tags: + - v* + +jobs: + github: + + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Set up JDK 11 + uses: actions/setup-java@v1 + with: + java-version: 11 + - name: Cache Maven Dependencies + if: always() + uses: actions/cache@v1 + with: + path: ~/.m2/repository + key: mvn-repository + restore-keys: | + ${{ runner.os }}-build-${{ env.cache-name }}- + ${{ runner.os }}-build- + ${{ runner.os }}- + - name: Maven Release + id: maven_release + env: + GITHUB_ACTOR: ${{ github.actor }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GPG_PASSPHRASE: ${{ secrets.GPG_PRIVATE_KEY_PASSPHRASE }} + GPG_KEYNAME: ${{ secrets.GPG_PRIVATE_KEY_NAME }} + run: | + echo "${{ secrets.GPG_PRIVATE_KEY }}" | gpg --batch --no-tty --import + sed -i 's@__GITHUB_TOKEN__.*$@${{ secrets.GITHUB_TOKEN }}@g' ${{ github.workspace }}/.mvn/settings.xml + mvn deploy --settings ${{ github.workspace }}/.mvn/settings.xml --batch-mode --no-transfer-progress -Prelease,gpg,github -Dmaven.wagon.http.pool=false + echo "##[set-output name=tag;]$(echo ${{ github.ref }} | sed 's@refs/tags/@@g')" + - name: GitHub Release + id: github_release + uses: actions/create-release@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + tag_name: ${{ steps.maven_release.outputs.tag }} + release_name: ${{ steps.maven_release.outputs.tag }} + body: + draft: false + prerelease: false + - name: GitHub Release Upload + id: github_release_upload + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: find . -name "*.jar" -exec .github/upload-github-release-asset.sh repo=${{ github.repository }} id=${{ steps.github_release.outputs.id }} filename={} ";" + + bintray: + + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Set up JDK 11 + uses: actions/setup-java@v1 + with: + java-version: 11 + - name: Cache Maven Dependencies + if: always() + uses: actions/cache@v1 + with: + path: ~/.m2/repository + key: mvn-repository + restore-keys: | + ${{ runner.os }}-build-${{ env.cache-name }}- + ${{ runner.os }}-build- + ${{ runner.os }}- + - name: Maven Release + id: maven_release + env: + GITHUB_ACTOR: ${{ github.actor }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GPG_PASSPHRASE: ${{ secrets.GPG_PRIVATE_KEY_PASSPHRASE }} + GPG_KEYNAME: ${{ secrets.GPG_PRIVATE_KEY_NAME }} + run: | + echo "${{ secrets.GPG_PRIVATE_KEY }}" | gpg --batch --no-tty --import + sed -i 's@__BINTRAY_TOKEN__.*$@${{ secrets.BINTRAY_TOKEN }}@g' ${{ github.workspace }}/.mvn/settings.xml + mvn deploy --settings ${{ github.workspace }}/.mvn/settings.xml --batch-mode --no-transfer-progress -Prelease,gpg,bintray -Dmaven.wagon.http.pool=false diff --git a/.github/workflows/maven-verify.yml b/.github/workflows/maven-verify.yml new file mode 100644 index 0000000..9662d6e --- /dev/null +++ b/.github/workflows/maven-verify.yml @@ -0,0 +1,31 @@ +name: Verify + +on: + push: + tags-ignore: + - '*.*' + branches: + - master + +jobs: + verify: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v1 + - name: Set up JDK 11 + uses: actions/setup-java@v1 + with: + java-version: 11 + - name: Cache Maven Dependencies + uses: actions/cache@v1 + with: + path: ~/.m2/repository + key: mvn-repository + restore-keys: | + ${{ runner.os }}-build-${{ env.cache-name }}- + ${{ runner.os }}-build- + ${{ runner.os }}- + - name: Build with Maven + run: mvn verify --settings ${{ github.workspace }}/.mvn/settings.xml --batch-mode --no-transfer-progress -Dmaven.wagon.http.pool=false diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml deleted file mode 100644 index d5b73aa..0000000 --- a/.gitlab-ci.yml +++ /dev/null @@ -1,67 +0,0 @@ -variables: - MAVEN_CLI_OPTS: --batch-mode --no-transfer-progress -Dmaven.wagon.http.pool=false - MAVEN_RELEASE_VERSION: 0 - # When using dind service we need to instruct docker, to talk with the - # daemon started inside of the service. The daemon is available with - # a network connection instead of the default /var/run/docker.sock socket. - # - # The 'docker' hostname is the alias of the service container as described at - # https://docs.gitlab.com/ee/ci/docker/using_docker_images.html#accessing-the-services - # - # Note that if you're using GitLab Runner 12.7 or earlier with the Kubernetes executor and Kubernetes 1.6 or earlier, - # the variable must be set to tcp://localhost:2375 because of how the - # Kubernetes executor connects services to the job container - # DOCKER_HOST: tcp://localhost:2375 - # - DOCKER_HOST: tcp://localhost:2375 - # https://www.testcontainers.org/ci/ci.html#gitlab - DOCKER_DRIVER: overlay2 - -image: docker:18.05 - -services: - - eu.gcr.io/tfw-server/dind:18.05 - -stages: - - maven - -maven_deploy: - stage: maven - image: maven:3.6-jdk-11-slim - only: - refs: - - master - except: - - tags - before_script: - - .mvn/mvn-entrypoint.sh - script: - - mvn deploy ${MAVEN_CLI_OPTS} -Pjacoco - - mvn sonar:sonar ${MAVEN_CLI_OPTS} -Psonar - - mvn jacoco:report -Pjacoco - - cat target/site/jacoco/index.html | grep -o 'Total]*>[^<]*]*>\([0-9]\{1,3\}\)%' - coverage: '/^Total.*>([0-9]{1,3})\s*%$/' - cache: - key: ${CI_JOB_STAGE} - paths: - - .mvn/repository - -maven_release: - stage: maven - image: maven:3.6-jdk-11-slim - only: - - /^v(\d+\.)?(\d+\.)?(\*|\d+)$/ - except: - - branches - before_script: - - .mvn/mvn-entrypoint.sh - script: - - mvn deploy ${MAVEN_CLI_OPTS} -Pjacoco,release - - mvn sonar:sonar ${MAVEN_CLI_OPTS} -Psonar - - mvn jacoco:report -Pjacoco - - cat target/site/jacoco/index.html | grep -o 'Total]*>[^<]*]*>\([0-9]\{1,3\}\)%' - coverage: '/^Total.*>([0-9]{1,3})\s*%$/' - cache: - key: ${CI_JOB_STAGE} - paths: - - .m2/repository diff --git a/.mvn/settings.xml b/.mvn/settings.xml new file mode 100644 index 0000000..78acc4c --- /dev/null +++ b/.mvn/settings.xml @@ -0,0 +1,65 @@ + + + + + github + schulzp + __GITHUB_TOKEN__ + + + bintray + schulzp + __BINTRAY_TOKEN__ + + + + + gpg + + ${env.GPG_KEYNAME} + ${env.GPG_PASSPHRASE} + + + + github + + true + + + github::https://maven.pkg.github.com/traum-ferienwohnungen/smallrye-metrics-async-timed + + + + github + GitHub Apache Maven Packages + https://maven.pkg.github.com/traum-ferienwohnungen/smallrye-metrics-async-timed + + true + + + true + + + + + + bintray + + bintray::https://api.bintray.com/maven/traum-ferienwohnungen/maven/smallrye-metrics-async-timed/;publish=1 + + + + bintray + JFrog Bintray Apache Maven Packages + https://dl.bintray.com/traum-ferienwohnungen/maven + + true + + + true + + + + + + diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 9df8d1f..5827688 100644 --- a/README.md +++ b/README.md @@ -3,21 +3,41 @@ This library provides annotation-based timing for methods returning promised values, namely `java.util.concurrent.CompletionStage` and `io.smallrye.mutiny.Uni`. -## Usage +## Installation -Annotate any bean method returning one of the aforementioned types with `com.traum.microprofile.metrics.annotation.AsyncTimed`. +Please add our bintray repository: + +```xml + + + bintray + JFrog Bintray Apache Maven Packages + https://dl.bintray.com/traum-ferienwohnungen/maven + + +``` -## Release - -```shell -mvn versions:set $MAVEN_CLI_OPTS -DnewVersion=$MAVEN_RELEASE_VERSION -git ls-files . | grep 'pom\.xml$' | xargs git add -git commit -m "[release] set version to $MAVEN_RELEASE_VERSION" -git tag "v$MAVEN_RELEASE_VERSION" -m "[release] v$MAVEN_RELEASE_VERSION" -mvn deploy ${MAVEN_CLI_OPTS} -Pjacoco -Dmymavenrepo.read.url=${MYMAVENREPO_READ_URL} -Dmymavenrepo.write.url=${MYMAVENREPO_WRTITE_URL} -mvn versions:commit $MAVEN_CLI_OPTS -mvn versions:set $MAVEN_CLI_OPTS -DnextSnapshot=true -git ls-files . | grep 'pom\.xml$' | xargs git add -git commit -m "[release] prepared next version" +This library assumes [`io.smallrye:smallrye-metrics`](https://smallrye.io/docs/smallrye-metrics/2.4.0/index.html) is available at runtime. +Therefore, the minimum set of dependencies looks as follows: + +```xml + + + + io.smallrye + smallrye-metrics + 2.4.x + provided + + + com.traum + smallrye-metrics-async-timed + RELEASE + test + + ``` +## Usage + +Annotate any bean method returning one of the aforementioned types with `com.traum.microprofile.metrics.annotation.AsyncTimed`. diff --git a/pom.xml b/pom.xml index b8574ef..78918d7 100644 --- a/pom.xml +++ b/pom.xml @@ -6,12 +6,12 @@ com.traum smallrye-metrics-async-timed - 0.5.1 + 0.6.2-SNAPSHOT - scm:git:git@gitlab.tfw.io:tfw-packages/smallrye-metrics-async-timed.git - scm:git:git@gitlab.tfw.io:tfw-packages/smallrye-metrics-async-timed.git - https://gitlab.tfw.io/tfw-packages/smallrye-metrics-async-timed + scm:git:git@github.com:traum-ferienwohnungen/smallrye-metrics-async-timed.git + scm:git:git@github.com:traum-ferienwohnungen/smallrye-metrics-async-timed.git + https://github.com/traum-ferienwohnungen/smallrye-metrics-async-timed HEAD @@ -27,6 +27,14 @@ + + + The Apache Software License, Version 2.0 + http://www.apache.org/licenses/LICENSE-2.0.txt + repo + + + true 11 @@ -160,6 +168,15 @@ versions-maven-plugin 2.7 + + org.apache.maven.plugins + maven-deploy-plugin + 3.0.0-M1 + + true + 2 + + @@ -246,28 +263,37 @@ + + gpg + + + + org.apache.maven.plugins + maven-gpg-plugin + 1.6 + + + sign-artifacts + verify + + sign + + + ${gpg.keyname} + ${gpg.passphrase} + false + false + + -v + --pinentry-mode + loopback + + + + + + + + - - - - jcenter - https://jcenter.bintray.com/ - - - mymavenrepo - ${mymavenrepo.read.url} - - true - - - true - - - - - - mymavenrepo - ${mymavenrepo.write.url} - - diff --git a/release.sh b/release.sh new file mode 100755 index 0000000..39f1496 --- /dev/null +++ b/release.sh @@ -0,0 +1,12 @@ +#!/usr/bin/env bash + +MAVEN_RELEASE_VERSION=$1 + +./mvnw versions:set $MAVEN_CLI_OPTS -DnewVersion=$MAVEN_RELEASE_VERSION +git ls-files . | grep 'pom\.xml$' | xargs git add +git commit -m "[release] set version to $MAVEN_RELEASE_VERSION" +git tag "v$MAVEN_RELEASE_VERSION" -m "[release] v$MAVEN_RELEASE_VERSION" +./mvnw versions:commit $MAVEN_CLI_OPTS +./mvnw versions:set $MAVEN_CLI_OPTS -DnextSnapshot=true +git ls-files . | grep 'pom\.xml$' | xargs git add +git commit -m "[release] prepared next version"