Skip to content

Migrate openapi-diff artifacts to OpenAPITools (Maven & Docker) #165

Closed

Description

@joschi

After this repository has been successfully moved to @OpenAPITools, we should make the artifacts available under the OpenAPITools name.

This includes the Maven artifacts (currently com.qdesrame and com.github.joschi.openapi-diff and the Docker images (currently quen2404/openapi-diff and joschi/openapi-diff).

Activity

  1. jmini commented on Aug 31, 2020

    @jmini
    Member

    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 think org.openapitools.openapidiff should be used.

    For the artifactId, I would like to use a openapi-diff- prefix


    Core:

      <groupId>org.openapitools.openapidiff</groupId>
      <artifactId>openapi-diff-core</artifactId>

    Cli:

      <groupId>org.openapitools.openapidiff</groupId>
      <artifactId>openapi-diff-cli</artifactId>

    For the jar-with-dependencies jar we are using the all classifier with the same coordinates.

    Maven plugin (see issue: #152):

      <groupId>org.openapitools.openapidiff</groupId>
      <artifactId>openapi-diff-maven-plugin</artifactId>

    ...

  2. joschi commented on Sep 21, 2020

    @joschi
    ContributorAuthor

    @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?

  3. jimschubert commented on Oct 10, 2020

    @jimschubert
    Member

    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?

  4. jimschubert commented on Oct 10, 2020

    @jimschubert
    Member

    @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.

  5. jimschubert commented on Oct 10, 2020

    @jimschubert
    Member

    I've setup https://hub.docker.com/repository/docker/openapitools/openapi-diff as an automated build:

    • master ->openapitools/openapi-diff:latest
    • Tag matching regex /^[0-9]\.[0-9]\..*$/ ->openapitools/openapi-diff:{tag} where {tag} matches the tag being built

    I've kicked off builds for each of the following 2.x tags, since the 1.x tags did not include a Dockerfile:

    • 2.0.0-beta.1
    • 2.0.0-beta.2
    • 2.0.0-beta.3
    • 2.0.0-beta.4
  6. joschi commented on Oct 11, 2020

    @joschi
    ContributorAuthor

    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.

    I'm okay with either. 🤷

  7. jimschubert commented on Oct 11, 2020

    @jimschubert
    Member

    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.

  8. wing328 commented on Oct 12, 2020

    @wing328
    Member

    After reviewing the discussions, I'm also ok with either.

  9. joschi commented on Oct 12, 2020

    @joschi
    ContributorAuthor

    org.openapitools.openapidiff would be consistent with org.openapitools.empoa and org.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. 😉

  10. jimschubert commented on Oct 12, 2020

    @jimschubert
    Member

    @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?

  11. joschi commented on Oct 12, 2020

    @joschi
    ContributorAuthor

    @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-java action:
    https://github.com/actions/setup-java#publishing-using-apache-maven

  12. 7 remaining items

  13. joschi commented on Oct 14, 2020

    @joschi
    ContributorAuthor

    @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

  14. jimschubert commented on Oct 14, 2020

    @jimschubert
    Member

    Awesome. I wonder why the alpine base image decided to stop working.

    Let me know if I can help out in any other ways.

  15. joschi commented on Oct 14, 2020

    @joschi
    ContributorAuthor

    I wonder why the alpine base image decided to stop working.

    The name of the shaded artifact (UberJAR) changed. So it was a totally self-inflicted breakage.

    3a1ef03#diff-dd2c0eb6ea5cfc6c4bd4eac30934e2d5746747af48fef6da689e85b752f39557L8-R8

  16. jimschubert commented on Oct 17, 2020

    @jimschubert
    Member

    The name of the shaded artifact (UberJAR) changed. So it was a totally self-inflicted breakage.

    3a1ef03#diff-dd2c0eb6ea5cfc6c4bd4eac30934e2d5746747af48fef6da689e85b752f39557L8-R8

    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.

  17. joschi commented on Oct 19, 2020

    @joschi
    ContributorAuthor

    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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions