Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update pom.xml for release and add maven publishing workflow #24

Merged
merged 3 commits into from
Aug 17, 2024

Conversation

SanjulaGanepola
Copy link
Member

@SanjulaGanepola SanjulaGanepola commented Aug 16, 2024

Changes

  • Add project info to pom.xml
  • Add new plugins: maven-source-plugin, maven-javadoc-plugin, maven-gpg-plugin, nexus-staging-maven-plugin
  • Add maven publishing workflow

TODO

  • Setup on OSSRH
  • Add the following repository secrets:
    • OSSRH_USERNAME
    • OSSRH_TOKEN
    • GPG_SECRET_KEY
    • GPG_PUBLIC_KEY
    • GPG_PASSPHRASE

@ThePrez The changes in this PR follow closely with what is done in the JTOpen repo. There were some slight differences based on what was explained on https://central.sonatype.org/publish/publish-guide

Copy link

github-actions bot commented Aug 16, 2024

Dependency Review

The following issues were found:
  • ✅ 0 vulnerable package(s)
  • ✅ 0 package(s) with incompatible licenses
  • ✅ 0 package(s) with invalid SPDX license definitions
  • ⚠️ 2 package(s) with unknown licenses.
  • ⚠️ 1 packages with OpenSSF Scorecard issues.
See the Details below.

Snapshot Warnings

⚠️: No snapshots were found for the head SHA 56706a7.
Ensure that dependencies are being submitted on PR branches and consider enabling retry-on-snapshot-warnings. See the documentation for more information and troubleshooting advice.

License Issues

pom.xml

PackageVersionLicenseIssue Type
org.sonatype.plugins:nexus-staging-maven-plugin1.7.0NullUnknown License
org.apache.maven.plugins:maven-javadoc-plugin3.8.0NullUnknown License

OpenSSF Scorecard

PackageVersionScoreDetails
actions/actions/checkout 4.*.* 🟢 7.2
Details
CheckScoreReason
Code-Review🟢 10all changesets reviewed
Maintained🟢 79 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 7
CII-Best-Practices⚠️ 0no effort to earn an OpenSSF best practices badge detected
Branch-Protection⚠️ -1internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration
License🟢 10license file detected
Signed-Releases⚠️ -1no releases found
Binary-Artifacts🟢 10no binaries found in the repo
Dangerous-Workflow🟢 10no dangerous workflow patterns detected
Token-Permissions⚠️ 0detected GitHub workflow tokens with excessive permissions
SAST🟢 10SAST tool is run on all commits
Pinned-Dependencies🟢 4dependency not pinned by hash detected -- score normalized to 4
Packaging🟢 10packaging workflow detected
Security-Policy🟢 9security policy file detected
Fuzzing⚠️ 0project is not fuzzed
Vulnerabilities🟢 91 existing vulnerabilities detected
actions/actions/setup-java 4.*.* 🟢 6.4
Details
CheckScoreReason
Maintained🟢 34 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 3
Code-Review🟢 10all changesets reviewed
CII-Best-Practices⚠️ 0no effort to earn an OpenSSF best practices badge detected
Branch-Protection⚠️ -1internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration
Binary-Artifacts🟢 10no binaries found in the repo
Packaging⚠️ -1packaging workflow not detected
Dangerous-Workflow🟢 10no dangerous workflow patterns detected
Token-Permissions⚠️ 0detected GitHub workflow tokens with excessive permissions
License🟢 10license file detected
Pinned-Dependencies⚠️ 0dependency not pinned by hash detected -- score normalized to 0
SAST🟢 9SAST tool is not run on all commits -- score normalized to 9
Signed-Releases⚠️ -1no releases found
Fuzzing⚠️ 0project is not fuzzed
Security-Policy🟢 9security policy file detected
Vulnerabilities🟢 100 existing vulnerabilities detected
actions/actions/upload-release-asset 1.*.* 🟢 3.8
Details
CheckScoreReason
Code-Review🟢 4Found 5/12 approved changesets -- score normalized to 4
Maintained⚠️ 0project is archived
CII-Best-Practices⚠️ 0no effort to earn an OpenSSF best practices badge detected
Signed-Releases⚠️ -1no releases found
Dangerous-Workflow🟢 10no dangerous workflow patterns detected
Packaging⚠️ -1packaging workflow not detected
Binary-Artifacts🟢 10no binaries found in the repo
Token-Permissions⚠️ 0detected GitHub workflow tokens with excessive permissions
Branch-Protection⚠️ 0branch protection not enabled on development/release branches
Pinned-Dependencies🟢 6dependency not pinned by hash detected -- score normalized to 6
SAST⚠️ 0SAST tool is not run on all commits -- score normalized to 0
Fuzzing⚠️ 0project is not fuzzed
License🟢 10license file detected
Security-Policy🟢 9security policy file detected
Vulnerabilities⚠️ 048 existing vulnerabilities detected
actions/bruceadams/get-release 1.3.2 ⚠️ 2.3
Details
CheckScoreReason
Code-Review⚠️ 1Found 4/21 approved changesets -- score normalized to 1
Maintained⚠️ 00 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
CII-Best-Practices⚠️ 0no effort to earn an OpenSSF best practices badge detected
License🟢 10license file detected
Signed-Releases⚠️ -1no releases found
Packaging⚠️ -1packaging workflow not detected
Dangerous-Workflow⚠️ -1no workflows found
Binary-Artifacts🟢 10no binaries found in the repo
Token-Permissions⚠️ -1No tokens found
Pinned-Dependencies⚠️ -1no dependencies found
Branch-Protection⚠️ 0branch protection not enabled on development/release branches
Security-Policy⚠️ 0security policy file not detected
Fuzzing⚠️ 0project is not fuzzed
SAST⚠️ 0SAST tool is not run on all commits -- score normalized to 0
Vulnerabilities🟢 37 existing vulnerabilities detected
maven/org.apache.maven.plugins:maven-gpg-plugin 3.2.5 UnknownUnknown
maven/org.apache.maven.plugins:maven-javadoc-plugin 3.8.0 UnknownUnknown
maven/org.apache.maven.plugins:maven-source-plugin 3.3.1 UnknownUnknown
maven/org.sonatype.plugins:nexus-staging-maven-plugin 1.7.0 🟢 4
Details
CheckScoreReason
Code-Review⚠️ 1Found 3/25 approved changesets -- score normalized to 1
Maintained🟢 34 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 3
CII-Best-Practices⚠️ 0no effort to earn an OpenSSF best practices badge detected
Signed-Releases⚠️ -1no releases found
Packaging⚠️ -1packaging workflow not detected
Token-Permissions⚠️ -1No tokens found
Binary-Artifacts🟢 10no binaries found in the repo
Dangerous-Workflow⚠️ -1no workflows found
License⚠️ 0license file not detected
Pinned-Dependencies⚠️ -1no dependencies found
Branch-Protection⚠️ 0branch protection not enabled on development/release branches
Security-Policy🟢 10security policy file detected
Fuzzing⚠️ 0project is not fuzzed
Vulnerabilities🟢 100 existing vulnerabilities detected
SAST⚠️ 0SAST tool is not run on all commits -- score normalized to 0

Scanned Manifest Files

.github/workflows/release.yml
  • actions/checkout@4.*.*
  • actions/setup-java@4.*.*
  • actions/upload-release-asset@1.*.*
  • bruceadams/get-release@1.3.2
pom.xml
  • org.apache.maven.plugins:maven-gpg-plugin@3.2.5
  • org.apache.maven.plugins:maven-javadoc-plugin@3.8.0
  • org.apache.maven.plugins:maven-source-plugin@3.3.1
  • org.sonatype.plugins:nexus-staging-maven-plugin@1.7.0

@SanjulaGanepola SanjulaGanepola linked an issue Aug 16, 2024 that may be closed by this pull request
Signed-off-by: Sanjula Ganepola <Sanjula.Ganepola@ibm.com>
Signed-off-by: Sanjula Ganepola <Sanjula.Ganepola@ibm.com>
@ThePrez ThePrez marked this pull request as ready for review August 17, 2024 04:32
@ThePrez ThePrez merged commit 08aa09e into main Aug 17, 2024
2 checks passed
@ThePrez ThePrez deleted the feature/release-setup branch August 17, 2024 04:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add workflow for publishing java package with maven
2 participants