Generering af changelogs og release notes
Lær, hvordan De opretter tydelige changelogs og automatiserede release notes ud fra Deres Git-historik og conventional commits.
Generering af changelogs og release notes er en gratis Intensiv DevOps-uddannelse-lektion på CoddyKit. Dette er lektion 4 af 4. Du kan læse alle 3 lektioner i dette læringsspor gratis i deres fulde længde — derefter låser CoddyKit PRO alle lektioner op samt praktiske øvelser med en indbygget kodeeditor og en AI-underviser døgnet rundt. Den er en del af læringsforløbet i Intensiv DevOps-uddannelse, og dine fremskridt synkroniseres på tværs af nettet og CoddyKit-appen. Intensiv DevOps-uddannelse-kurset indeholder 4 lektioner i alt.
Hvad er en ændringslog
En ændringslog er en udvalgt og letlæselig liste over bemærkelsesværdige ændringer for hver version. Den ligger i en fil som CHANGELOG.md i roden af repositoryet.
Hvorfor ændringslogge er vigtige
Brugere og teammedlemmer læser ændringslogge for at forstå:
- nye funktioner
- fejlrettelser
- ændringer, der bryder kompatibiliteten
De gør opgraderinger sikrere og hurtigere.
Formatet Keep a Changelog
En almindelig konvention grupperer poster under overskrifterne: Tilføjet, Ændret, Rettet, Fjernet.
## [1.2.0] - 2024-05-01
### Added
- Search filters
### Fixed
- Login redirect bugKonventionelle commits
Konventionelle commits bruger præfikser som feat:, fix: og BREAKING CHANGE:, så værktøjer kan opbygge ændringslogge automatisk.
feat: add CSV export
fix: handle empty cart
feat!: drop Node 14 supportVis commits siden et tag
Du kan få en forhåndsvisning af ændringerne siden den seneste udgivelse ved at bruge git log med et tag-interval.
git log v1.1.0..HEAD --onelineFormateret log til noter
Formatér loggen som punktlinjer, der er velegnede til at indsætte i udgivelsesnoter.
git log v1.1.0..HEAD --pretty=format:'- %s'Værktøjer til automatiske ændringslogge
Værktøjer som standard-version eller conventional-changelog læser konventionelle commits og genererer ændringsloggen samt en versionsforøgelse.
npx standard-versionAutomatisk genererede noter fra GitHub
GitHub kan generere udgivelsesnoter automatisk ud fra mergede pull requests, når du opretter en udgivelse.
gh release create v1.2.0 --generate-notesKategorisering med mærkater
En .github/release.yml-fil knytter PR-mærkater til sektioner i ændringsloggen, så noter automatisk grupperer fejlrettelser og funktioner.
changelog:
categories:
- title: Features
labels: [feature]Gennemgang før publicering
Læs altid de genererede noter, før du publicerer dem. Automatiseringen laver et udkast, men et menneske redigerer formuleringerne og fremhæver ændringer, der bryder kompatibiliteten.
Sammenkædning med udgivelser
Knyt hver post i ændringsloggen til dens Git-tag og udgivelsesside, så læserne kan gå direkte til de præcise ændringer.
[1.2.0]: https://github.com/you/repo/compare/v1.1.0...v1.2.0Hurtig kontrol
Test din forståelse af ændringslogge og udgivelsesnoter.
Opsummering
Du har lært at generere ændringslogge:
- Brug formatet Keep a Changelog
- Konventionelle commits driver automatiseringen
git log v1..HEADviser en forhåndsvisning af ændringernegh release create --generate-notesopretter et udkast til noter ud fra PR'er
Lær Intensiv DevOps-uddannelse med en AI-underviser — gratis
Skriv og kør rigtig kode i din browser, få øjeblikkelig hjælp fra en AI-underviser døgnet rundt, og fortsæt, hvor du slap, på web eller i appen.
- Kurser
- 142
- Lektioner
- 568
Ofte stillede spørgsmål
Er lektionen “Generering af changelogs og release notes” gratis?
Ja — alle 3 lektioner i læringssporet Intensiv DevOps-uddannelse, inklusive “Generering af changelogs og release notes”, kan læses gratis i deres fulde længde her på webstedet. Derefter låser CoddyKit PRO alle lektioner op samt interaktive øvelser med en indbygget kodeeditor og en AI-underviser døgnet rundt. Intensiv DevOps-uddannelse-kurset indeholder 4 lektioner i alt.
Hvad lærer jeg i “Generering af changelogs og release notes”?
Lær, hvordan De opretter tydelige changelogs og automatiserede release notes ud fra Deres Git-historik og conventional commits. Du øver dig i Intensiv DevOps-uddannelse med praktisk kode, som du kører direkte i browseren, og en AI-vejleder døgnet rundt besvarer dine spørgsmål, mens du arbejder dig gennem lektionen.
Skal jeg have erfaring for at begynde på Intensiv DevOps-uddannelse?
Der kræves ingen tidligere erfaring. Intensiv DevOps-uddannelse på CoddyKit er tilrettelagt for både begyndere og øvede, så du kan starte her eller fra begyndelsen og lære i dit eget tempo. Dette er lektion 4 af 4.
Hvor lang tid tager lektionen “Generering af changelogs og release notes”?
De fleste CoddyKit-lektioner tager cirka 5–10 minutter. Hver lektion er kort og interaktiv, så du gør løbende fremskridt og kan fortsætte, hvor du slap – på både web og app.
Kan jeg skrive og køre kode i denne Intensiv DevOps-uddannelse-lektion?
Ja. Alle Intensiv DevOps-uddannelse-lektioner har en indbygget kodeeditor, så du kan skrive og køre rigtig kode direkte i din browser og få øjeblikkelig feedback fra AI – uden lokal opsætning.
Alle lektioner i dette kursus
- Semantisk versionsstyring med tags
- Oprettelse og administration af releases
- Release-branches og hotfixes
- Generering af changelogs og release notes