feat: 1588 publish to maven central #1596

jcpitre · 2023-10-19T00:55:26Z

Summary:
closes #1588
Modified the build.gradle of the modules to upload (main, core and model) to add signing and publishing.
Added a Github action to publish the released artifact.

Expected behavior:
To publish, you need to have a git tag directly in the commit, with semantic versioning format.
The GH action can be triggered by hand or for a prerelease or release.

If successful, there will be a new staging repo in https://s01.oss.sonatype.org/index.html#stagingRepositories containing the artefacts (e.g. https://s01.oss.sonatype.org/content/repositories/orgmobilitydata-1029/. This repo will likely be deleted by the time you read this, but it should be similar)
The artefacts should be signed (look for .sha1, .sha256 etc)

To test the deployment, you have to manually close the repo on sonatype. This will trigger acceptance tests for maven (artefacts are signed, etc).
If successful the staging repo will be available to use for testing. You will need to add a repository with the URL mentioned above (or similar) to your pom.xml or build.gradle.

Once the testing is done, the repo can be manually promoted to maven central.

Please make sure these boxes are checked before submitting your pull request - thanks!

Run the unit tests with gradle test to make sure you didn't break anything
Format the title like "feat: [new feature short description]". Title must follow the Conventional Commit Specification(https://www.conventionalcommits.org/en/v1.0.0/).
Linked all relevant issues
Include screenshot(s) showing how this pull request works and fixes the issue(s)

... into env vars.

github-actions · 2023-10-19T00:56:24Z

This contribution does not follow the conventions set by the Google Java style guide. Please run the following command line at the root of the project to fix formatting errors: ./gradlew goJF.

github-actions · 2023-10-19T01:40:31Z

✅ Rule acceptance tests passed.
New Errors: 0 out of 1476 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1476 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1476 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1476 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1476 sources (~0 %) are corrupted.
Commit: 3d05261
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

… main. The java format verifier does not like it.

github-actions · 2023-10-19T13:28:31Z

This contribution does not follow the conventions set by the Google Java style guide. Please run the following command line at the root of the project to fix formatting errors: ./gradlew goJF.

davidgamez · 2023-10-19T13:23:07Z

.github/workflows/release_jars.yml

+on:
+  release:
+    types: [ prereleased, released ]
+    workflow_dispatch:


It might be more generic to trigger the action by listening to tag pushes so that any new tag will be published.
Example:

on: push: tags: - '*'

Sure. But it should be restricted to tags that have the proper syntax (e.g. v4.2.1), If not the axion-release plugin will not work. I initially was using an uppercase V at the beginning of the version, and it did not work! It came with some headaches.

Did not put tag as a trigger in the end since the other part of publish_assets.yml needs a release trigger.

davidgamez · 2023-10-19T13:24:47Z

.github/workflows/release_jars.yml

+# At this point it should manually be closed, which will trigger acceptance tests for maven central (but not transfer yet)
+# Once closed, thew repo is available for testing.
+# After testing, it can be manually promoted on the sonatype site, which will then publish to maven central.
+name: Upload Release Jars to Sonatype


What do you think if we add the jobs implemented here to

gtfs-validator/.github/workflows/publish_assets.yml

Line 1 in 85beb70

name: Upload Release Assets

to avoid sync issues between what we have in the Github repository and what is published in maven

So you want to combine the two actions?
Or have one trigger the other

Combining the two actions seems to be a reasonable solution.

Combining is possible, but having a tag push as a trigger instead of a release event will not work since the action uploads to a release and needs the release event to obtain the release url.
To keep them combined we could trigger on both the release event and the tag push event, but select the steps that are run on each event, ie dont tun the upload to release if it's not a release event.
Or we could separate them and each have their own trigger.

I see your point. My bad, I was looking at the default example from upload-release-asset action and the implementation is the other way around. They create a release as part of the tag push: https://github.com/actions/upload-release-asset#example-workflow---upload-a-release-asset.
To conclude, let's leave the pre-release and release triggers.

Still kept them combined but added a workflow_dispatched trigger that is used only by the sonatype upload.

github-actions · 2023-10-19T14:21:12Z

✅ Rule acceptance tests passed.
New Errors: 0 out of 1476 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1476 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1476 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1476 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1476 sources (~0 %) are corrupted.
Commit: 725bb72
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

… push a tag instead of release or prerelease.

github-actions · 2023-10-19T16:09:02Z

This contribution does not follow the conventions set by the Google Java style guide. Please run the following command line at the root of the project to fix formatting errors: ./gradlew goJF.

github-actions · 2023-10-19T17:02:22Z

✅ Rule acceptance tests passed.
New Errors: 0 out of 1476 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1476 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1476 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1476 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1476 sources (~0 %) are corrupted.
Commit: 9a05aed
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

…spatch (manual) but limited it to the Sonatype upload.

github-actions · 2023-10-19T18:57:33Z

This contribution does not follow the conventions set by the Google Java style guide. Please run the following command line at the root of the project to fix formatting errors: ./gradlew goJF.

github-actions · 2023-10-19T19:37:57Z

This contribution does not follow the conventions set by the Google Java style guide. Please run the following command line at the root of the project to fix formatting errors: ./gradlew goJF.

github-actions · 2023-10-19T19:44:05Z

This contribution does not follow the conventions set by the Google Java style guide. Please run the following command line at the root of the project to fix formatting errors: ./gradlew goJF.

github-actions · 2023-10-19T21:15:34Z

✅ Rule acceptance tests passed.
New Errors: 0 out of 1476 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1476 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1476 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1476 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1476 sources (~0 %) are corrupted.
Commit: f318a05
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

davidgamez · 2023-10-20T13:03:08Z

This looks good to me. As a last ask, can you update the release documentation, adding the steps to publish to maven? Thanks!

github-actions · 2023-10-20T16:56:16Z

✅ Rule acceptance tests passed.
New Errors: 0 out of 1476 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Errors: 0 out of 1476 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
New Warnings: 0 out of 1476 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
Dropped Warnings: 0 out of 1476 datasets (~0%) are invalid due to code change, which is less than the provided threshold of 1%.
0 out of 1476 sources (~0 %) are corrupted.
Commit: 06700cb
Download the full acceptance test report here (report will disappear after 90 days).
✅ Rule acceptance tests passed.

jcpitre · 2023-10-25T15:57:09Z

You can now use Maven Central as repository for released versions of GTFS-validator artifacts.
For the dependency in pom.xml or build.gradle, the groupId is now
org.mobilitydata.gtfs-validator
(the version built with Jitpack had groupId com.github.MobilityData.gtfs-validator)

jcpitre and others added 30 commits October 12, 2023 13:18

Test

cb74009

Added 1Password secret reference

812806e

... into env vars.

Test

0a655b7

Test

9c5fda8

Test

b7f0e94

Test

0228b9f

Test

fcbbeb9

Test

c72ab3b

Publish to sonatype

210220c

Added checkout code

4b28f0e

Test

7c3ac75

Test

c37fad2

Test

3536238

Test

839ae96

Test

94deaa4

Test 2

16dc9bc

Test 2

0b7d65a

Test 2

41d30b4

Test 2

ad1b099

Pushing tag along with changes

259ce9b

Trying again to push tag long commit

2dfb065

Trying again to push tag long commit bis

7264c9c

Trying to trigger on pushing a tag.

b3ba2a7

Printing the version.

b09f4ce

Added --info to gradle.

4fd18f1

Problems with SONATYPE_USEENAME

273b93d

Added debug prints

16f94dd

Debugging sonatype upload

d06feea

Debugging sonatype upload 2

284bfad

Debugging sonatype upload 3

86a0339

jcpitre added 2 commits October 18, 2023 20:23

Cleaned up

2c599ec

Added some instructions for publishing

ea16c7d

Removed a link that was in a comment in model referring to a class in…

a19f9bb

… main. The java format verifier does not like it.

davidgamez reviewed Oct 19, 2023

View reviewed changes

Integrated release_jars.yml into release_jars. Changed the trigger to…

d73b1e3

… push a tag instead of release or prerelease.

Went back to release events in publish_assets. Also added workflow_di…

7529720

…spatch (manual) but limited it to the Sonatype upload.

Added tag push trigger temporarily to be able to test.

d4d2052

Test was successful, removed the tag push trigger

b30167e

Updated format

fbecc1b

Added doc for release.

d9155c3

davidgamez approved these changes Oct 20, 2023

View reviewed changes

Corrected typo

c9ca2ee

jcpitre merged commit fdd6c9b into master Oct 20, 2023
333 checks passed

jcpitre deleted the 1588-publish-to-maven-central branch October 20, 2023 17:15

emmambd mentioned this pull request Oct 24, 2023

Jitpack packages should be generated at release time #1585

Closed

jcpitre mentioned this pull request Oct 25, 2023

GTFS Validator as library #755

Closed

emmambd mentioned this pull request Nov 13, 2023

docs: Update NOTICE_MIGRATION.md #1599

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: 1588 publish to maven central #1596

feat: 1588 publish to maven central #1596

jcpitre commented Oct 19, 2023 •

edited

github-actions bot commented Oct 19, 2023

github-actions bot commented Oct 19, 2023

github-actions bot commented Oct 19, 2023

davidgamez Oct 19, 2023

jcpitre Oct 19, 2023

jcpitre Oct 19, 2023

davidgamez Oct 19, 2023

jcpitre Oct 19, 2023

davidgamez Oct 19, 2023

jcpitre Oct 19, 2023 •

edited

davidgamez Oct 19, 2023

jcpitre Oct 19, 2023

github-actions bot commented Oct 19, 2023

github-actions bot commented Oct 19, 2023

github-actions bot commented Oct 19, 2023

github-actions bot commented Oct 19, 2023

github-actions bot commented Oct 19, 2023

github-actions bot commented Oct 19, 2023

github-actions bot commented Oct 19, 2023

davidgamez commented Oct 20, 2023

github-actions bot commented Oct 20, 2023

jcpitre commented Oct 25, 2023

feat: 1588 publish to maven central #1596

feat: 1588 publish to maven central #1596

Conversation

jcpitre commented Oct 19, 2023 • edited

github-actions bot commented Oct 19, 2023

github-actions bot commented Oct 19, 2023

github-actions bot commented Oct 19, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jcpitre Oct 19, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Oct 19, 2023

github-actions bot commented Oct 19, 2023

github-actions bot commented Oct 19, 2023

github-actions bot commented Oct 19, 2023

github-actions bot commented Oct 19, 2023

github-actions bot commented Oct 19, 2023

github-actions bot commented Oct 19, 2023

davidgamez commented Oct 20, 2023

github-actions bot commented Oct 20, 2023

jcpitre commented Oct 25, 2023

jcpitre commented Oct 19, 2023 •

edited

jcpitre Oct 19, 2023 •

edited