DevOps-bootcamp · leksjon

Generere endringslogger og versjonsnotater

Lær hvordan De kan lage tydelige endringslogger og automatiserte versjonsnotater fra Git-historikken og conventional commits.

Leksjon 4 av 413 trinn

Generere endringslogger og versjonsnotater er en gratis leksjon i DevOps-bootcamp på CoddyKit. Dette er leksjon 4 av 4. Du kan lese valgfritt 3 leksjoner fra denne læringsstien gratis i sin helhet – deretter låser CoddyKit PRO opp alle leksjoner, samt praktisk øving med en innebygd kodeeditor og en AI-veileder som er tilgjengelig døgnet rundt. Den er en del av læringsløpet i DevOps-bootcamp, og fremdriften din synkroniseres mellom nettet og CoddyKit-appen. Kurset i DevOps-bootcamp inneholder totalt 4 leksjoner.

Hva er en endringslogg?

En endringslogg er en redigert, lettlest oversikt over viktige endringer for hver versjon. Den ligger i en fil som CHANGELOG.md i roten av repoet.

Hvorfor endringslogger er viktige

Brukere og teammedlemmer leser endringslogger for å forstå:

Nye funksjoner
Feilrettinger
Endringer som bryter bakoverkompatibilitet

De gjør oppgraderinger tryggere og raskere.

Keep a Changelog-formatet

En vanlig konvensjon grupperer oppføringer under overskriftene: Lagt til, Endret, Rettet, Fjernet.

## [1.2.0] - 2024-05-01
### Added
- Search filters
### Fixed
- Login redirect bug

Conventional Commits

Conventional commits bruker prefikser som feat:, fix: og BREAKING CHANGE:, slik at verktøy automatisk kan bygge endringslogger.

feat: add CSV export
fix: handle empty cart
feat!: drop Node 14 support

Liste over commits siden en tag

Du kan forhåndsvise hva som er endret siden forrige utgivelse ved å bruke git log med et tag-intervall.

git log v1.1.0..HEAD --oneline

Formatere loggen for notater

Formater loggen som punktlinjer som egner seg for innliming i versjonsmerknader.

git log v1.1.0..HEAD --pretty=format:'- %s'

Automatiserte verktøy for endringslogger

Verktøy som standard-version eller conventional-changelog leser conventional commits og genererer endringsloggen samt en versjonsøkning.

npx standard-version

GitHub-genererte notater

GitHub kan generere versjonsmerknader automatisk fra mergede pull requests når du oppretter en utgivelse.

gh release create v1.2.0 --generate-notes

Kategorisere med etiketter

En .github/release.yml-fil kobler PR-etiketter til seksjoner i endringsloggen, slik at feilrettinger og funksjoner grupperes automatisk i notatene.

changelog:
  categories:
    - title: Features
      labels: [feature]

Gjennomgå før publisering

Les alltid gjennom genererte notater før publisering. Automatisering lager et utkast, men et menneske redigerer formuleringene og fremhever endringer som bryter bakoverkompatibilitet.

Koble til utgivelser

Sørg for at hver oppføring i endringsloggen lenker til Git-taggen og utgivelsessiden, slik at leserne kan gå direkte til den nøyaktige diffen.

[1.2.0]: https://github.com/you/repo/compare/v1.1.0...v1.2.0

Hurtigsjekk

Test forståelsen din av endringslogger og versjonsmerknader.

Besvar den i den interaktive leksjonen

Oppsummering

Du har lært å generere endringslogger:

Bruk Keep a Changelog-formatet
Conventional commits driver automatiseringen
git log v1..HEAD forhåndsviser endringer
gh release create --generate-notes lager et utkast til notater fra PR-er

Gratis å komme i gang

Lær deg DevOps-bootcamp med en AI-veileder – gratis

Skriv og kjør ekte kode i nettleseren, få umiddelbar hjelp fra en AI-veileder som er tilgjengelig døgnet rundt, og fortsett der du slapp – på nettet eller i appen.

Kurs: 142
Leksjoner: 568

Start læringen gratis Se hele kurset

Ofte stilte spørsmål

Er leksjonen «Generere endringslogger og versjonsnotater» gratis?

Ja – du kan lese valgfritt 3 av leksjonene i læringsstien DevOps-bootcamp, inkludert «Generere endringslogger og versjonsnotater», gratis i sin helhet her på nettet. Deretter låser CoddyKit PRO opp alle leksjoner, samt interaktiv øving med en innebygd kodeeditor og en AI-veileder som er tilgjengelig døgnet rundt. Kurset i DevOps-bootcamp inneholder totalt 4 leksjoner.

Hva lærer jeg i «Generere endringslogger og versjonsnotater»?

Lær hvordan De kan lage tydelige endringslogger og automatiserte versjonsnotater fra Git-historikken og conventional commits. Du øver på DevOps-bootcamp med praktisk kode som du kjører direkte i nettleseren, mens en AI-veileder som er tilgjengelig døgnet rundt, svarer på spørsmålene dine mens du jobber deg gjennom leksjonen.

Trenger jeg erfaring for å begynne med DevOps-bootcamp?

Ingen tidligere erfaring er nødvendig. DevOps-bootcamp på CoddyKit er lagt opp for både nybegynnere og viderekomne, så De kan begynne her eller helt fra start og lære i Deres eget tempo. Dette er leksjon 4 av 4.

Hvor lang tid tar leksjonen «Generere endringslogger og versjonsnotater»?

De fleste CoddyKit-leksjoner tar omtrent 5–10 minutter. Hver leksjon er kort og interaktiv, slik at De gjør jevne fremskritt og kan fortsette akkurat der De slapp – både på nettet og i appen.

Kan jeg skrive og kjøre kode i denne DevOps-bootcamp-leksjonen?

Ja. Alle DevOps-bootcamp-leksjoner har en innebygd kodeeditor, slik at De kan skrive og kjøre ekte kode direkte i nettleseren og få umiddelbar tilbakemelding fra AI – uten lokal konfigurering.

Alle leksjonene i dette kurset

Semantisk versjonering med tags
Opprette og administrere releases
Release-brancher og hotfixer
Generere endringslogger og versjonsnotater

← Tilbake til DevOps-bootcamp