paullisto-insight / mulesoft-spec-upload

Automatically publish an API Specification OAS YAML to the MuleSoft Anypoint Exchange upon Pull Request

Mulesoft API Specification Upload

To automatically publish 'api.yaml' to Mulesoft Anypoint:

• Create a Release
• Ensure that the Tag of the Release matches this format [0-9].[0-9].[0-9]
• Add a Name, Description and Publish.

Ensure that the --apiVersion argument in /.github/workflows/main.yml matches your API major version number in your Semantic Version reference (i.e. 1.x.x).

Your API Specification will uploaded using the repository name as the name of the API and the Tag_Name of the Release as the API Version.

mulesoft-spec-upload's Issues

API Versioning strategy

Thanks for adding this repo @paullisto-insight!

A thought on reviewing the code ( I haven't tested this). https://github.com/paullisto-insight/mulesoft-spec-upload/blob/main/.github/workflows/main.yml#L23 it uses the PR name to indicate version in <group_id>/<asset_id>/<version>.

Usually API version numbers seldom change as it's disruptive to consumers. We try limit versions to major functionality changes or significant changes to the schema. ${{ github.run_id }} will give a value that links back to the GitHub Action run within the repository.

This will allow linking the uploaded assets back to the workflow execution. Useful if the current PR has had multiple deployments.