From 4ec3a21944ae3f443daa2ac9f1503efe5bef6687 Mon Sep 17 00:00:00 2001 From: Stefan Seifert Date: Thu, 13 Jan 2022 11:11:38 +0100 Subject: [PATCH] initial commit --- .gitattributes | 53 +++++++++++++ .gitignore | 36 +++++++++ LICENSE | 201 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 48 ++++++++++++ action.yml | 77 +++++++++++++++++++ 5 files changed, 415 insertions(+) create mode 100644 .gitattributes create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 action.yml diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..1a0f926 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,53 @@ +# This is the central .gitattributes file for all pro!vision GIT repos. Please do not change it on project-level. +# See https://jira.pvtool.org/confluence/x/IACuBg for details. + +# Declare text files with unix file ending +*.conf text eol=lf +*.config text eol=lf +*.css text eol=lf +*.dtd text eol=lf +*.esp text eol=lf +*.ecma text eol=lf +*.hbrs text eol=lf +*.htm text eol=lf +*.html text eol=lf +*.java text eol=lf +*.jpage text eol=lf +*.js text eol=lf +*.json text eol=lf +*.jsp text eol=lf +*.mustache text eol=lf +*.tld text eol=lf +*.launch text eol=lf +*.log text eol=lf +*.php text eol=lf +*.pl text eol=lf +*.project text eol=lf +*.properties text eol=lf +*.props text eol=lf +*.sass text eol=lf +*.scss text eol=lf +*.sh text eol=lf +*.shtm text eol=lf +*.shtml text eol=lf +*.sql text eol=lf +*.svg text eol=lf +*.txt text eol=lf +*.vm text eol=lf +*.xml text eol=lf +*.xsd text eol=lf +*.xsl text eol=lf +*.xslt text eol=lf + + +# Declare windows-specific text files with windows file ending +*.asp text eol=crlf +*.asax text eol=crlf +*.asa text eol=crlf +*.aspx text eol=crlf +*.bat text eol=crlf +*.cmd text eol=crlf +*.cs text eol=crlf +*.csproj text eol=crlf +*.reg text eol=crlf +*.sln text eol=crlf diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d1f1e72 --- /dev/null +++ b/.gitignore @@ -0,0 +1,36 @@ +target/ +pom.xml.tag +pom.xml.releaseBackup +pom.xml.versionsBackup +pom.xml.next +release.properties +maven-eclipse.xml +infinitest.filters + +node_modules/ +npm-debug.log + +.nodejs +.project +.classpath +.settings +.externalToolBuilders +.pmd +.eclipse-pmd +.checkstyle +.idea +.vagrant +*.iml +.DS_Store +*.retry +.rubygems +.sass-cache +.rubygems-gem-maven-plugin +*.sublime-* +*nbactions*.xml +.temp/ +.vlt +.vlt-sync* +.brackets.json + +pom-test.xml diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5c304d1 --- /dev/null +++ b/LICENSE @@ -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 new file mode 100644 index 0000000..422cafc --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ + github-action-maven-build-sonar +====== + +Composite GitHub Action that verifies a Maven Build and analyzes the results in SonarCloud. + +Usage example: + +``` +# Build validation + +name: Build + +on: + push: + branches-ignore: + - master + - experimental/** + pull_request: + types: [opened, synchronize, reopened] + branches-ignore: + - master + - experimental/** + workflow_dispatch: + +jobs: + build: + + runs-on: ${{ matrix.os }} + strategy: + matrix: + java: [8, 11, 17] + os: [ubuntu-latest] + distribution: [temurin] + + steps: + - name: Maven Build with SonarCloud + uses: wcm-io-devops/github-action-maven-build-sonar@v1 + with: + os: ${{ matrix.os }} + java-version: ${{ matrix.java }} + maven-executable: ./mvnw + sonar-run-on-os: ubuntu-latest + sonar-run-on-java-version: 11 + sonar-token: ${{ secrets.SONAR_TOKEN }} + github-token: ${{ secrets.GITHUB_TOKEN }} +``` + +For all parameters, see [action.yml](action.yml). diff --git a/action.yml b/action.yml new file mode 100644 index 0000000..ab1055a --- /dev/null +++ b/action.yml @@ -0,0 +1,77 @@ +name: Maven Build with SonarCloud +description: Composite GitHub Action that verifies a Maven Build and analyzes the results in SonarCloud + +inputs: + os: + description: Operation system + required: true + java-version: + description: Java version + required: true + java-distribution: + description: Java distribution + required: false + default: temurin + maven-executable: + description: Maven executable + required: false + default: mvn + maven-verify-args: + description: Maven goals and command line parameter to verify the build + required: false + default: -s ./.maven-settings.xml -Pcontinuous-integration -B -U clean verify + maven-sonar-args: + description: Maven goals and command line parameters to execute sonar analysis + required: false + default: org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=${{github.repository_owner}}_${{github.event.repository.name}} -Dsonar.projectName=${{github.event.repository.name}} + maven-additional-args: + description: Additional maven goals or command line parameters to be added to all maven calls + required: false + sonar-run-on-os: + description: Run sonar (only) on this operation system + required: true + sonar-run-on-java-version: + description: Run sonar (only) on this java version + required: true + sonar-token: + description: SONAR_TOKEN secret. This is not available for external PRs, so it may be empty and Sonar is skipped in this case. + required: false + github-token: + description: GITHUB_TOKEN secret + required: true + +runs: + using: composite + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis + + - name: Setup JDK + uses: actions/setup-java@v2 + with: + distribution: ${{ inputs.java-distribution }} + java-version: ${{ inputs.java-version }} + cache: maven + + - name: Cache SonarCloud packages + uses: actions/cache@v1 + with: + path: ~/.sonar/cache + key: ${{ runner.os }}-sonar + restore-keys: ${{ runner.os }}-sonar + + - name: Build and verify (with Sonar) + env: + GITHUB_TOKEN: ${{ inputs.github-token }} # Needed to get PR information, if any + SONAR_TOKEN: ${{ inputs.sonar-token }} + run: ${{ inputs.maven-executable }} ${{ inputs.maven-verify-args }} ${{ inputs.maven-additional-args }} ${{ inputs.maven-sonar-args }} + shell: bash + if: ${{ inputs.os == inputs.sonar-run-on-os && inputs.java-version == inputs.sonar-run-on-java-version && inputs.sonar-token != '' }} + + - name: Build and verify (without Sonar) + run: ${{ inputs.maven-executable }} ${{ inputs.maven-verify-args }} ${{ inputs.maven-additional-args }} + shell: bash + if: ${{ inputs.os != inputs.sonar-run-on-os || inputs.java-version != inputs.sonar-run-on-java-version || inputs.sonar-token == '' }}