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 recommendations on Publishing libraries to Maven Central #180

Merged
merged 1 commit into from
Nov 27, 2024

Conversation

rtyley
Copy link
Member

@rtyley rtyley commented Nov 27, 2024

What is being recommended?

The main message is that Scala projects should use gha-scala-library-release-workflow to publish to Maven Central, as we've standardised on it and it does all the right things:

  • achieve zero-onboarding for new developers: Any developer who has write access to a repo should be able
    to publish a release of the library, at the click of a button.
  • securely handle release credentials - only allow access to release credentials for parts of the release process
    that need them.
  • automated version compatibility checking - to avoid binary-incompatibility causing runtime errors.
  • reduce per-repo config - adding library-publishing to a repo should add minimal boilerplate.

As Scala is not the only JVM-language that we publish to Maven Central- we have several Android/Kotlin projects! - I've tried to make the document generally applicable for publishing to Maven Central, regardless of JVM-based language.

What's the context?

The prompt to do this now comes from our plan to significantly reduce the number of users with admin access to Sonatype to a minimal number - @davidfurey suggested it would be a good idea to have clear documentation for other developers about who the remaining admins are, in the case of an emergency! So this documentation provides that, along with other guidance about publishing to Maven Central.

The Google Drive documents for those details, linked to from this public markdown doc, are not public, but have constrained access appropriate to their audience.

@rtyley rtyley requested review from a team, davidfurey and ab-gnm and removed request for a team November 27, 2024 11:58
Copy link
Member

@davidfurey davidfurey left a comment

Choose a reason for hiding this comment

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

Thanks Roberto!

@davidfurey
Copy link
Member

Perhaps this should be linked to from https://github.com/guardian/recommendations/blob/main/README.md ?

@rtyley rtyley force-pushed the publish-libraries-to-maven-central branch from 3cb13dd to f15eb7a Compare November 27, 2024 12:22
@rtyley
Copy link
Member Author

rtyley commented Nov 27, 2024

Perhaps this should be linked to from https://github.com/guardian/recommendations/blob/main/README.md ?

Ah good point! I've revised my commit to update the main README.md with a link 👍

@rtyley rtyley merged commit bcb8a97 into main Nov 27, 2024
3 checks passed
@rtyley rtyley deleted the publish-libraries-to-maven-central branch November 27, 2024 12:24
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