Notable change description text format
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 25/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- javascript
- Ambito
- release
Direzione di ricerca
Inizia dal commento collegato della Release issue 1063 e dalla formulazione esistente del bot notable-change. Confronta i marcatori Markdown proposti con il formato alternativo git-node-release.summary e traccia l’automazione di release-summary; il lavoro è completato quando esiste un formato concordato e documentato che l’automazione possa estrarre in modo coerente per gli annunci delle release e i brevi post sui social.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Spinning off from https://github.com/nodejs/Release/issues/1063#issuecomment-2539972117 , when the notable-change label is applied, the bot says:
Please suggest a text for the release notes if you'd like to include a more detailed summary, then proceed to update the PR description with the text or a link to the notable change suggested text comment. Otherwise, the commit will be placed in the Other Notable Changes section.
But it's still not very clear what you are supposed to do - at least my interpretation is that one should just edit the PR description and the release announcement will copy whatever that's in the PR description, but it seems that's rarely the case. In the past notable changes PR I see people do all sorts of random stuff based on their own interpretation of what the bot says, and in the past release announcements I've also seen summaries that didn't match any of the things people did in the PR. There are many notable change PRs with well-formed descriptions which don't get copy pasted into the release announcement, presumably because they don't match some unspecified format to indicate that the descriptions they prepared are the text that are supposed to be copied.
To copy what I discussed with @aduh95 on slack
I wonder if we can devise a standard way for people to denote a block of markdown as text proposed for notable changes, and the the automation can gather them to form the basis of the release announcement and open a PR to the blog automatically while the proposal PR is sent. Maybe a one line short description too, so the automation can collect them and form a Bluesky post, and send a PR to the Bluesky repo, which can be edited a bit there and may or may not have to be sent from the official account (can be sent from releaser’s account first and then the PR is amended into a repost, but at least the text can be collaborated on GitHub)
A proposed format that would be automatable:
<!-- Bullet point content for release micro post: foo.bar -->
<!-- Summary for release announcement starts -->
## Support `foo.bar`
This pull request introduces `foo.bar`, which allows users to do bar with foo.
<!-- Summary for release announcement ends -->
And the automation will replace "This pull request" with "This release" for the text summaries, leading to
-
In the bluesky post draft generated for the release, it will be something like
Node.js v1.2.3 is out! - foo.bar -
In the blog post and changelog etc. draft generated, it will just include whatever in that starts/ends block, and replace "This pull request" with "This release", and leave it for people to make the wording look less weird for a release announcement.
If we want to go with the less-human readable but more explicit about what's automated route, or allow multiple summaries in one PR (I imagine this would be generated by something like git node release summary, and I modeled it after what's used by https://github.com/nodejs/node-core-utils/blob/main/docs/ncu-team.md).
<!-- git-node-release.summary.title(fooBar, "foo.bar") -->
<!-- git-node-release.summary.start(fooBar) -->
## Support `foo.bar`
This pull request introduces `foo.bar`, which allows users to do bar with foo.
<!-- git-node-release.summary.end(fooBar) -->
(I am not sure whether this is too cryptic, but anyway just to kick off some discussion about how to actually specify an automatable format instead of continue leaving it open to interpretation).
- Lingua principale
- JavaScript
- Stelle
- 4.4k
- Fork
- 675
- Merge medio
- 22h 29m
- PR unite (30g)
- 1
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di nodejs/Release
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
-
Release-agenda
Difficoltà 1/5 1-3 ore Idoneità per principianti 78/100
-
CitGM backlog Aperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 50/100
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 20/100
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 35/100
Tutte le issue di nodejs/Release
Issue simili
-
bug confirmed issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
open-webui/open-webui#30750 · 1 commento ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
Mend: dependency security vulnerability untriaged
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100