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

Add configuration for MavenCentral publishing #779

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

zsmb13
Copy link

@zsmb13 zsmb13 commented Jan 18, 2021

Adds build configuration to publish the library to MavenCentral, based on this article and this library's config.

This will require the following inputs:

  • signing.keyId: the ID of the GPG key pair used for signing, the last eight characters of its fingerprint
  • signing.password: the passphrase of the key pair
  • signing.secretKeyRingFile: the location of the exported private key
  • ossrhUsername and osshrPassword: login credentials for https://oss.sonatype.org/
  • stagingProfileId: value from Sonatype

Usage:

  • Set the values described above in local.properties or environment variables
  • ./gradlew assembleRelease (build)
  • ./gradlew publishReleasePublicationToSonatypeRepository (sign and upload artifact to Sonatype)
  • ./gradlew closeAndReleaseRepository (close and release Sonatype repo)

I didn't include CI config in the first draft, but it would be fairly easy and convenient to plug this all into GitHub Actions.

Comment on lines 20 to 22
def PUBLISH_GROUP_ID = 'com.github.chrisbanes'
def PUBLISH_ARTIFACT_ID = 'PhotoView'
def PUBLISH_VERSION = '2.3.0'
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These coordinates might have to be reconsidered as MavenCentral requires verification for publishing with a given group ID

Comment on lines 24 to 49
ext["signing.keyId"] = ''
ext["signing.password"] = ''
ext["signing.secretKeyRingFile"] = ''
ext["ossrhUsername"] = ''
ext["ossrhPassword"] = ''
ext["sonatypeStagingProfileId"] = ''

File localPropsFile = project.rootProject.file('local.properties')
if (localPropsFile.exists()) {
println "Found local props file, loading props from there"
Properties p = new Properties()
new FileInputStream(localPropsFile).withCloseable { is ->
p.load(is)
}
p.each { name, value ->
ext[name] = value
}
} else {
println "No local props file, loading env vars instead"
ext["signing.keyId"] = System.getenv('SIGNING_KEY_ID')
ext["signing.password"] = System.getenv('SIGNING_PASSWORD')
ext["signing.secretKeyRingFile"] = System.getenv('SIGNING_SECRET_KEY_RING_FILE')
ext["ossrhUsername"] = System.getenv('OSSRH_USERNAME')
ext["ossrhPassword"] = System.getenv('OSSRH_PASSWORD')
ext["sonatypeStagingProfileId"] = System.getenv('SONATYPE_STAGING_PROFILE_ID')
}
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Set to empty values initially, so that they exist, but are empty. This allows people to build the debug variant locally.
  • Use local.properties values if they're there, this can be used for publishing from a local machine.
  • Use environment variables if the local.properties file was missing, can be used on CI.

@ursusursus
Copy link

bump please

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.

2 participants