Cut A Version And Announce It
A 3-step recipe with ReadMe. We can help you get access.
Recipe · 3 steps
Cut A Version And Announce It
with ReadMe
Create a branch, upload its API definition, and announce it in the changelog.
- Create the new branch (version) for the release.
- Upload the API definition that powers the reference docs on the new branch.
- Post an "added" changelog entry announcing the new version.
What you'll need to have ready
- branchName: The name of the new branch (version) to create.
- definition: The OpenAPI definition document to upload to the branch.
- changelogTitle: The title of the launch changelog post.
- changelogBody: The Markdown body of the launch changelog post.
- apiKey: ReadMe API key used as a Bearer token.
For your developer
Arazzo workflow readme:release-version, 3 operations: {$sourceDescriptions.branchesApi.url}#/paths/~1branches/post → {$sourceDescriptions.apisApi.url}#/paths/~1branches~1{branch}~1apis/post → {$sourceDescriptions.changelogApi.url}#/paths/~1branches~1{branch}~1changelogs/post. Specs on APIs.io.