capabilities.work

Upsert A Changelog Post

A 3-step recipe with ReadMe. We can help you get access.

Recipe · 3 steps

Upsert A Changelog Post

with ReadMe

Update a changelog post if its slug exists, otherwise create it.

  1. List changelog posts on the branch to detect whether the target slug exists.
  2. Update the existing changelog post identified by slug.
  3. Create a new changelog post when no post with the target slug exists.
What you'll need to have ready
  • branch: The branch (version) the changelog post lives on.
  • slug: The slug of the changelog post to upsert.
  • title: The changelog post title to write.
  • body: The Markdown body to write.
  • type: The change type (added | fixed | improved | deprecated | removed).
  • apiKey: ReadMe API key used as a Bearer token.
For your developer

Arazzo workflow readme:upsert-changelog-post, 3 operations: {$sourceDescriptions.changelogApi.url}#/paths/~1branches~1{branch}~1changelogs/get → {$sourceDescriptions.changelogApi.url}#/paths/~1branches~1{branch}~1changelogs~1{slug}/put → {$sourceDescriptions.changelogApi.url}#/paths/~1branches~1{branch}~1changelogs/post. Specs on APIs.io.