Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 1.34 KB

RELEASE.md

File metadata and controls

37 lines (25 loc) · 1.34 KB
Raw

Releasing buf-action

This document outlines how to create a release of buf-action. We follow the best practices outlined in the GitHub Actions documentation and GitHub Actions Toolkit tutorial.

  1. Clone the repo, ensuring you have the latest main.

  2. On a new branch, run the following commands to update the version of the action:

VERSION=X.Y.Z VERSION_SHORT=X make updateversion

  1. Open a PR titled "Prepare for vX.Y.Z". Once it's reviewed and CI passes, merge it.

    Make sure no new commits are merged until the release is complete.

  2. Create a new release using the Github UI:

    • Under “Choose a tag”, type in “vX.Y.Z” to create a new tag for the release upon publish.
    • Target the main branch.
    • Title the Release “vX.Y.Z”.
    • Click “set as latest release”.
    • Click "Publish this Action to the GitHub Marketplace".

  3. Publish the release.

  4. Pull down the latest main and move the tags for major (vX) and minor (vX.Y) releases.

git tag -fa vX -m "Update vX tag"
git tag -fa vX.Y -m "Update vX.Y tag"
git push origin vX vX.Y --force