Skip to content

README.md

Latest commit

 

History

History
77 lines (55 loc) · 3.01 KB

README.md

File metadata and controls

77 lines (55 loc) · 3.01 KB

PrimeLib App

Application to automatically update openapi specs and the generated client libraries.

Usage

Commands Description
primelib-app run generate Creates a PR with updates to the OpenAPI Spec and the generated code.
primelib-app run release Checks if the latest commit in the main branch has a release, automatically creating a tag if not.

Project Configuration

Projects are configured using a primelib.yaml file in the root of the repository.

Example - Java

modules:
  - spec_file: openapi.json # local spec file
    spec_url: https://osv.dev/docs/osv_service_v1.swagger.json # update spec from url
    spec_script: | # patch openapi spec before generation
      jq '.host = "api.osv.dev"' "$1" | sponge "$1" # set api host
      jq 'walk(if type == "object" and has("operationId") then .operationId |= sub("^OSV_"; "") else . end)' "$1" | sponge "$1" # remove prefix from operationId
    config: # openapi generator config
      generatorName: prime-client-java-feign
      invokerPackage: io.github.primelib.osv4j
      apiPackage: io.github.primelib.osv4j.api
      modelPackage: io.github.primelib.osv4j.model
      enablePostProcessFile: true
      additionalProperties:
        projectArtifactGroupId: io.github.primelib
        projectArtifactId: osv4j

App Configuration

Environment Variable Description
PRIMEAPP_FOOTER_HIDE Set to true to disable the footer note in the merge request description.
PRIMEAPP_FOOTER_CUSTOM Set to replace the footer with your custom text.

Platform Configuration

You are required to have the environment variables for one platform set.

GitHub App

Create a GitHub App and configure it with the following permissions:

  • Repository contents: Read & write
  • Pull requests: Read & write
  • Commit statuses: Read & write
  • Checks: Read & write
  • Metadata: Read-only

Create a private key and store it in a file.

Environment Variable Description
GITHUB_APP_ID The ID of the GitHub App.
GITHUB_APP_PRIVATE_KEY_FILE The path to the private key file.

GitLab User

Create a GitLab user and generate a personal access token with the following permissions:

  • api
Environment Variable Description
GITLAB_SERVER The GitLab server URL.
GITLAB_ACCESS_TOKEN The personal access token.

License

Released under the MIT license.