Release: Use GitHub automatic release notes

Open
#76 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Stale
Tech stack
github-actions
Domain
release

Research direction

Start by reading the release action and related discussion in #24, focusing on the current changelog, metainfo, and issues-tag handling. Compare that flow with GitHub's automatic release notes; done means the release process uses the automatic notes and no longer depends on the broken issues tag.

Written by the indexing model from the issue text.

Description

Needs Design
Problem

These changelogs are mostly useful for maintainers and packagers but we're using the user-facing release notes from metainfo. We also now have the problem that the release action doesn't know what to do with the issues tag

Proposal

While the release action has been broken for creating release tags we've been using Github's automatic release notes generation and it's been fine? It does a good enough job just summarizing the commits and it's kinda neat that it has like "so and so made their first commit in this release" kind of stuff. So we probably don't actually need to be doing anything fancy here?

Prior Art (Optional)

See also #24

Dominant language
Shell
Stars
39
Forks
9
No merged PRs in 30d

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.

More from elementary/actions

All issues in elementary/actions

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.