Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 738 Bytes

RELEASE.md

File metadata and controls

29 lines (20 loc) · 738 Bytes

How to publish a release

Twinagle uses Github Releases.

  1. Go to https://github.com/soundcloud/twinagle/releases
  2. Click "Draft a new release"
  3. Enter the version number for the release in the tag field
  4. Update the release notes. The following template works well:
    # :warning: Breaking Changes
    
    * enrage users for good reasons (#666)
    
    # :star2: Improvements
    
    * embiggen the betterness (#689)
    
    # :beetle: Bugfixes
    
    * stop doing it wrong (#420)
    
    # :chart_with_upwards_trend: Updates
    
    * Finagle, probably
    * relevant version bumps for dependencies, e.g. ScalaPB
    
  5. Publish the release when you're ready. A build will kick off in CI and publish the tagged release to Maven Central.