microsoft / microsoft/beachball

Add release notes to Github Releases

Open
#885 4 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

plugin or peer
Dominant language
TypeScript
Stars
815
Forks
93
Avg merge
2d 13h
Merged PRs (30d)
12

Description

I'd like to incorporate release notes into each published Github Release.

If this feature is out-of-scope for beachball directly, it might be nice to include an example configuration in the documentation on the best way to achieve this with hooks, Github Actions, etc.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files or tests. First determine how beachball publishes GitHub Releases and whether release-note generation belongs in beachball or an external hook or GitHub Action; define the intended configuration or workflow and verify that a published release contains the notes.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.