microsoft / microsoft/go

Release automation should put together release notes

Open
#604 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

release-automation
Dominant language
Go
Stars
431
Forks
44
Avg merge
21h 18m
Merged PRs (30d)
30

Description

We should consider where release notes should go that are specific to the Microsoft build of Go. In particular, FIPS-related changes.

It would be reasonable to have a place where release notes can be checked in, like doc/go1.18-fips.html. Maybe inside patch file descriptions, with a formatting convention that helps extract relevant info? Then, the release-go pipeline can detect the notes, format them, and distribute them in the GitHub release (and maybe more places).

Contributor guide

No contributing guide indexed for this repository

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

Start by examining the release-go pipeline and the existing release process, then compare the proposed doc/go1.18-fips.html location with patch file descriptions. Determine how Microsoft Go-specific, especially FIPS-related, notes could be identified, formatted, and distributed in the GitHub release. Done requires an agreed storage and extraction convention plus corresponding automation.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
devops, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.