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

build: unpin OpenAPI specs from v2.0.0-alpha.2 URL refs, use REMOTE #3315

Commits on Jun 13, 2024

  1. build: unpin OpenAPI specs from v2.0.0-alpha.2 URL refs, use REMOTE

    On a high level this is a find & replace operation where the occurrences of the
    first bullet point were replaced with the second bullet point:
    * `"$ref": "https://raw.githubusercontent.com/hyperledger/cactus/v2.0.0-alpha.2`
    * `"$ref": "../../../../..`
    
    The firs bullet point above is called a URL reference while the second one is
    called a REMOTE references (remote as in a different spec file on the file-system).
    
    1. With this change, we unlock the release process being able to issue code that
    is working on the latest OpenAPI specifications that we are cross-referencing
    from one package to another.
    2. Previously you had to manually update the references in about a hundred
    and fifty locations to make sure that the versions are bumped but after this
    change this happens automatically as the newly introduced bundling process
    and the usage of the REMOTE references instead of URL references.
    3. The problem so far with the release process was that with the URL references
    we dependended on the existence of a pushed git tag for a successful release build.
    But we cannot git push the tag before having performed a successful release build,
    so this was a chicken-egg problem that had to be somehow untangled from its
    circular dependency hell and this change is what makes it happen by no longer
    depending on the git tags having been pushed to the upstream repository.
    
    Related to, but does not yet fix: https://github.com/hyperledger/cacti/issues/2175
    
    Depends on hyperledger-cacti#3288
    
    Signed-off-by: Peter Somogyvari <peter.somogyvari@accenture.com>
    petermetz committed Jun 13, 2024
    Configuration menu
    Copy the full SHA
    3f2a67e View commit details
    Browse the repository at this point in the history