You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Migrate openapi-diff artifacts to OpenAPITools (Maven & Docker) #165
@quen2404@jmini@wing328 After preparing the move to the suggested Maven coordinates, who would be able to set up the automation for releases to Maven Central and to the Docker Hub organization?
Why the recommendation for group org.openapitools.openapidiff? This means we would have to go through the entire onboarding process with Sonatype again. Can we just keep it org.openapitools?
@quen2404@jmini@wing328 After preparing the move to the suggested Maven coordinates, who would be able to set up the automation for releases to Maven Central and to the Docker Hub organization?
If we agree to change maven to org.openapitools, I can set these up. I unfortunately don't have enough bandwidth to work through onboarding another Maven project and managing separate creds.
Why the recommendation for group org.openapitools.openapidiff? This means we would have to go through the entire onboarding process with Sonatype again.
Accounts having permissions to publish artifacts in the group com.example on Sonatype OSSRH also have permissions to publish artifacts in any sub-group, for example com.example.submodule1.
If we agree to change maven to org.openapitools, I can set these up.
Accounts having permissions to publish artifacts in the group com.example on Sonatype OSSRH also have permissions to publish artifacts in any sub-group, for example com.example.submodule1.
Interesting. I probably knew this, but forgot. I guess org.openapitools.openapidiff:openapi-diff is good, but does seem a little redundant to me. I'll ping @wing328 for his opinion.
@jimschubert Ultimately it's up to you. We could try it with the regular credentials for Sonatype OSSRH which you mentioned and see if they are working with org.openapitools.openapidiff. 😉
@joschi Let's go with org.openapitools.openapidiff. I'm assuming we'd be releasing similar separate artifacts to the validator project:
core library
cli
maven plugin
gradle plugin
And it may make sense to have these all grouped under org.openapitools.openapidiff to avoid confusion with openapi-generator.
My initial hesitation was with regards to maintaining additional credentials, which isn't the case.
I see you have CircleCI and GitHub Workflows for building. I'd personally prefer using GitHub Workflows for build and deployment. Do you mind if we setup these releases in GitHub Workflows?
Ahh... I completely missed that the cli-*-all part of the glob was different from the original name. I tested locally and verified that the original name and the glob matched against my build outputs, but I guess I hadn't cleaned since the change.
Activity
jmini commentedon Aug 31, 2020
About the maven coordinates, we had similar thoughts about the OpenAPI Style Validator project. See corresponding issue: OpenAPITools/openapi-style-validator#10
For the
groupId, I thinkorg.openapitools.openapidiffshould be used.For the
artifactId, I would like to use aopenapi-diff-prefixCore:
Cli:
For the
jar-with-dependenciesjar we are using theallclassifier with the same coordinates.Maven plugin (see issue: #152):
...
Move Maven coordinates to new group ID and artifact IDs
Replace maven-assembly-plugin with maven-shade-plugin
joschi commentedon Sep 21, 2020
@quen2404 @jmini @wing328 After preparing the move to the suggested Maven coordinates, who would be able to set up the automation for releases to Maven Central and to the Docker Hub organization?
jimschubert commentedon Oct 10, 2020
Why the recommendation for group
org.openapitools.openapidiff? This means we would have to go through the entire onboarding process with Sonatype again. Can we just keep itorg.openapitools?jimschubert commentedon Oct 10, 2020
If we agree to change maven to
org.openapitools, I can set these up. I unfortunately don't have enough bandwidth to work through onboarding another Maven project and managing separate creds.jimschubert commentedon Oct 10, 2020
I've setup https://hub.docker.com/repository/docker/openapitools/openapi-diff as an automated build:
openapitools/openapi-diff:latest/^[0-9]\.[0-9]\..*$/->openapitools/openapi-diff:{tag}where{tag}matches the tag being builtI've kicked off builds for each of the following 2.x tags, since the 1.x tags did not include a Dockerfile:
joschi commentedon Oct 11, 2020
Accounts having permissions to publish artifacts in the group
com.exampleon Sonatype OSSRH also have permissions to publish artifacts in any sub-group, for examplecom.example.submodule1.I'm okay with either. 🤷
jimschubert commentedon Oct 11, 2020
Interesting. I probably knew this, but forgot. I guess
org.openapitools.openapidiff:openapi-diffis good, but does seem a little redundant to me. I'll ping @wing328 for his opinion.wing328 commentedon Oct 12, 2020
After reviewing the discussions, I'm also ok with either.
joschi commentedon Oct 12, 2020
org.openapitools.openapidiffwould be consistent withorg.openapitools.empoaandorg.openapitools.openapistylevalidator.@jimschubert Ultimately it's up to you. We could try it with the regular credentials for Sonatype OSSRH which you mentioned and see if they are working with
org.openapitools.openapidiff. 😉jimschubert commentedon Oct 12, 2020
@joschi Let's go with
org.openapitools.openapidiff. I'm assuming we'd be releasing similar separate artifacts to the validator project:And it may make sense to have these all grouped under
org.openapitools.openapidiffto avoid confusion with openapi-generator.My initial hesitation was with regards to maintaining additional credentials, which isn't the case.
I see you have CircleCI and GitHub Workflows for building. I'd personally prefer using GitHub Workflows for build and deployment. Do you mind if we setup these releases in GitHub Workflows?
joschi commentedon Oct 12, 2020
@jimschubert Thanks a lot!
GitHub workflows is fine for me.
It would be great if you could set up the credentials as described in the
actions/setup-javaaction:https://github.com/actions/setup-java#publishing-using-apache-maven
7 remaining items
Add release version as input to `release` workflow
Use correct release profile (release-sign-artifacts)
Configure Maven release profile and automatic deployment
Add development version as input to `release` workflow
Fix Docker image build
Add project URL, issue & CI management to POM
joschi commentedon Oct 14, 2020
@jimschubert Thanks for all the effort!
I've picked up where you left and made the release workflow work and fixed the Docker build.
Here's the successful run for releasing openapi-diff 2.0.0-beta.5:
https://github.com/OpenAPITools/openapi-diff/runs/1252425534
jimschubert commentedon Oct 14, 2020
Awesome. I wonder why the alpine base image decided to stop working.
Let me know if I can help out in any other ways.
joschi commentedon Oct 14, 2020
The name of the shaded artifact (UberJAR) changed. So it was a totally self-inflicted breakage.
3a1ef03#diff-dd2c0eb6ea5cfc6c4bd4eac30934e2d5746747af48fef6da689e85b752f39557L8-R8
Migrate Java packages to org.openapitools.openapidiff
jimschubert commentedon Oct 17, 2020
Ahh... I completely missed that the
cli-*-allpart of the glob was different from the original name. I tested locally and verified that the original name and the glob matched against my build outputs, but I guess I hadn't cleaned since the change.Migrate Java packages to org.openapitools.openapidiff (#187)
joschi commentedon Oct 19, 2020
With the release of openapi-diff 2.0.0-beta.6 (https://github.com/OpenAPITools/openapi-diff/runs/1273814348) with the correct Docker and Maven coordinates and the correct Java package names, I think we can close this issue.
Thanks @jimschubert, @jmini, @wing328, and @quen2404 for your support!