actions / actions/toolkit

Release notes not made for latest releases

Open
#2,239 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
TypeScript
Stars
5.9k
Forks
1.8k
PR merge metrics
No merged PRs in 30d

Description

Describe the bug

Release notes for each package are provided in a RELEASES.md file. These allow maintainers of dependent projects to easily understand the nature of a new release when evaluating a dependency bump. That information is especially useful in this "monorepo", since the usual alternative of using Git tags to obtain the changesets for a bump is not available to us.

New releases were made for several of the packages: https://github.com/actions/toolkit/pull/2233.

🐛 Release note entries were not made for those releases. This is inconvenient for the maintainers of the many dependent projects.

To Reproduce

  1. Determine the latest version of a package. For example, here we can see that the latest version of @actions/core is 2.0.2: https://www.npmjs.com/package/@actions/core
  2. Open the release notes for that package. In the example of @actions/core, they are here: https://github.com/actions/toolkit/blob/main/packages/core/RELEASES.md

🐛 There is no entry in the release notes for the latest release.

Expected behavior

The missing release note entries are added.

A formal release procedure is defined that specifies a release notes entry must be added prior to making a release.

Copilot's configuration is such that it will comply with that formal procedure when bumping package versions.

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

Review the releases from pull request #2233 and compare the latest package versions with each package's RELEASES.md, starting with packages/core/RELEASES.md. Identify every missing entry, then read the repository's existing release procedure and Copilot configuration guidance. Done means the missing notes are added and the procedure requires them before a release.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, release
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.