Spuneți că sunteți dezvoltator și că utilizați Git pentru unul dintre proiectele dvs. Doriți să partajați modificările pe care le-ați făcut utilizatorilor dvs., dar nu știți cum. Ei bine, atunci acest articol este pentru tine.

În ultima parte a acestei serii, v-am împărtășit cum să scrieți un mesaj de comitere bun.

V-am oferit o imagine de ansamblu asupra beneficiilor scrierii unui bun commit și am menționat posibilitatea de a genera un registru de schimbări.

În acest articol, veți afla ce este un jurnal de schimbări împreună cu două moduri de a-l genera – unul simplu și unul sofisticat.

Ce este un registru de schimbări?

Un jurnal de schimbări este un fișier care împărtășește o listă ordonată cronologic cu modificările pe care le-ați făcut la proiectul dvs. Este adesea organizat în funcție de versiune cu data urmată de o listă de funcții adăugate, îmbunătățite și eliminate.

La nivel global, există două moduri de a scrie un jurnal de schimbări:

  • în mod obișnuit: creați un fișier text și începeți să enumerați toate modificările dvs. cu o anumită dată
  • alegerea dezvoltatorului (alias opțiunea leneșă): generați automat jurnalul de schimbări din mesajele dvs. de confirmare. Am vești bune pentru tine – asta vei învăța în acest articol!

„Un registru de schimbări este un jurnal sau o înregistrare a tuturor modificărilor notabile aduse unui proiect. Proiectul este deseori un site web sau un proiect software, iar jurnalul de schimbări include de obicei înregistrări ale modificărilor, cum ar fi remedierea erorilor, funcții noi etc. ” – Wikipedia

De ce este esențial?

Cred că, chiar și acum, vă întrebați de ce este esențial și de ce ar trebui să vă alocați timp pentru ao crea.

Un registru de schimbări este un fel de rezumat al tuturor modificărilor dvs. Ar trebui să fie ușor de înțeles atât de utilizatorii care utilizează proiectul dvs., cât și de dezvoltatorii care lucrează la acesta.

Într-o lume în care totul evoluează rapid, un utilizator trebuie să știe dacă site-ul web / software-ul pe care îl utilizează se schimbă. S-ar putea să fiți surprinși, dar oamenilor le place să citească postări pe blog sau o pagină de actualizare pe site-ul dvs. web.

Pentru un dezvoltator, de exemplu, dacă proiectul este mare, poate fi interesant să știi cum evoluează software-ul la care lucrează.

Sau dacă lucrați la un proiect open-source, puteți găsi un fișier „CHANGELOG.md” în depozitul GitHub. Acest fișier are ca scop informarea contribuabililor cu privire la cele mai recente actualizări ale proiectului.

Un ghid pentru incepatori pentru Git Ce este un
CHANGELOG.md din Depozit GitHub Angular.js

Unde le găsim?

Jurnalele de schimburi sunt peste tot! Bine, au adesea stiluri și locații diferite, dar sunt literalmente în fiecare proiect.

Am creat o scurtă listă cu câteva locuri unde puteți găsi un jurnal de schimbări.

  • O postare pe blog. Un jurnal de schimbări poate fi livrat sub un articol care împărtășește ultimele caracteristici punct cu punct.
  • Un fișier „CHANGELOG.md” într-un depozit GitHub.
  • O secțiune Changelog de pe site-ul / software-ul dvs. preferat. Iată un exemplu cu instrumentul de gestionare a sarcinilor TickTick.
  • În „Ce este nou” pe magazinul Android și IOS.
1611575526 543 Un ghid pentru incepatori pentru Git Ce este un
Bifați secțiunea „Ce este nou” pe Android
1611575526 689 Un ghid pentru incepatori pentru Git Ce este un
Bifați secțiunea „Ce este nou” pe iOS

Generare automată a jurnalului de modificări

În această parte, vom genera împreună primul nostru registru de schimbări.

Făcând această sarcină, veți înțelege de ce poate fi util să comiteți urmând câteva reguli.

O confirmare excelentă și explicită nu trebuie modificată și poate fi adăugată direct în jurnalul de schimbări.

Dacă sunteți interesat să generați un fișier necesar fără nicio personalizare sau înfrumusețare, vă recomand prima cale; în caz contrar, a doua este mai bună.

Notă: Unele site-uri web, cum ar fi Păstrați un registru de modificări explicați că nu ar trebui să creați un jurnal de schimbări doar prin copierea și lipirea comitetelor dvs. git (consultați modul simplu). Într-adevăr, vă recomand să încercați să evitați acest lucru dacă lucrați la un produs profesional.

Cu toate acestea, în zilele noastre, există câteva generatoare avansate care vă permit să schimbați jurnalele dvs. git în registre de schimbări (consultați modul sofisticat).

Cum se generează un jurnal de schimbări (modul simplu)

Utilizând acest prim mod, nu aveți nevoie de nici o condiție prealabilă. Tot ce aveți nevoie este să tastați câteva comenzi în depozitul dvs. Git.

Ca un simplu memento, atunci când tastați „git log”, este afișată o listă cu toate confirmările dvs.

$ git log

// Output
commit f6986f8e52c1f889c8649ec75c5abac003102999 (HEAD -> master, origin/master, origin/HEAD)
Author: Sam Katakouzinos <sam.katakouzinos@gmail.com>
Date:   Tue Mar 10 11:41:18 2020 +1100

    docs(developers): commit message format typo
    
    Any line of the commit message cannot be longer *than* 100 characters!
    
    Closes #17006

commit ff963de73ab8913bce27a1e75ac01f53e8ece1d9
Author: Chives <chivesrs@gmail.com>
Date:   Thu Feb 6 19:05:57 2020 -0500

    docs($aria): get the docs working for the service
    
    Closes #16945

commit 2b28c540ad7ebf4a9c3a6f108a9cb5b673d3712d
Author: comet <hjung524@gmail.com>
Date:   Mon Jan 27 19:49:55 2020 -0600

    docs(*): fix spelling errors
    
    Closes #16942

Această comandă poate lua câțiva parametri. Le vom folosi pentru a schimba rezultatul și pentru a obține unul îmbunătățit pentru a genera registrul nostru de schimbări.

Tastând următoarea comandă, veți avea o ieșire cu un commit pe fiecare linie.

$ git log --oneline --decorate

// Output
f6986f8e5 (HEAD -> master, origin/master, origin/HEAD) docs(developers): commit message format typo
ff963de73 docs($aria): get the docs working for the service
2b28c540a docs(*): fix spelling errors
68701efb9 chore(*): fix serving of URI-encoded files on code.angularjs.org
c8a6e8450 chore(package): fix scripts for latest Node 10.x on Windows
0cd592f49 docs(angular.errorHandlingConfig): fix typo (wether --> whether)
a4daf1f76 docs(angular.copy): fix `getter`/`setter` formatting
be6a6d80e chore(*): update copyright year to 2020
36f17c926 docs: add mention to changelog
ff5f782b2 docs: add mention to changelog
27460db1d docs: release notes for 1.7.9
add78e620 fix(angular.merge): do not merge __proto__ property

Este mai bine, dar să vedem ce putem face cu următorul.

$ git log --pretty=”%s”

// Output
docs(developers): commit message format typo
docs($aria): get the docs working for the service
docs(*): fix spelling errors
chore(*): fix serving of URI-encoded files on code.angularjs.org
chore(package): fix scripts for latest Node 10.x on Windows
docs(angular.errorHandlingConfig): fix typo (wether --> whether)
docs(angular.copy): fix `getter`/`setter` formatting
chore(*): update copyright year to 2020
docs: add mention to changelog
docs: add mention to changelog
docs: release notes for 1.7.9
fix(angular.merge): do not merge __proto__ property

Cu acesta, puteți imprima lista de confirmări cu stilul dorit.

„% S” corespunde titlului de comitere în sine. Puteți modifica șirul pentru a stiliza comiterea dvs. după cum doriți.

În cazul nostru, vrem să creăm o listă.

$ git log --pretty="- %s"

// Output
- docs(developers): commit message format typo
- docs($aria): get the docs working for the service
- docs(*): fix spelling errors
- chore(*): fix serving of URI-encoded files on code.angularjs.org
- chore(package): fix scripts for latest Node 10.x on Windows
- docs(angular.errorHandlingConfig): fix typo (wether --> whether)
- docs(angular.copy): fix `getter`/`setter` formatting
- chore(*): update copyright year to 2020
- docs: add mention to changelog
- docs: add mention to changelog
- docs: release notes for 1.7.9
- fix(angular.merge): do not merge __proto__ property

Tu ai făcut-o! Ați creat un registru de schimbare simplu.

Notă: Dacă doriți să mergeți mai departe și să salvați jurnalul de schimbări mai repede: în loc să copiați și să lipiți rezultatul într-un fișier, redirecționați-l către terminalul dvs. tastând „git log –pretty =” -% s “> CHANGELOG.md”

Cum se generează un jurnal de schimbări (modul sofisticat)

Condiții prealabile

Acum vom explora un mod sofisticat de a genera un registru de schimbări. Ideea din spatele procesului rămâne aceeași, dar de data aceasta vom folosi alte instrumente pentru a ne ajuta.

Îți amintești când în ultima parte a acestei serii Am scris despre liniile directoare Git?

Notă: Orientările Git sunt un set de reguli pentru a vă scrie mai bine comitetele. Aceste instrucțiuni vă ajută să adăugați o anumită structură la angajamentele dvs.

Când utilizați un ghid pentru proiectul dvs., puteți utiliza instrumente pentru a genera un registru de schimbări. De cele mai multe ori, aceste instrumente sunt mai bune, deoarece vă permit să creați un jurnal de modificări formatat de reducere.

În acest exemplu, vom folosi un generator simplu care funcționează cu majoritatea liniilor directoare. Numele lui este “generate-changelog”, Și este disponibil pe NPM (Node Package Manager).

Acest instrument va crea un jurnal de schimbări stilizat, dar nu este cel cu cele mai multe caracteristici. Am decis să-l folosesc pentru că este un exemplu excelent pentru un începător. Dacă doriți să mergeți mai departe, vă rugăm să consultați lista de instrumente de jurnal de schimbări de mai jos:

Iată câteva instrumente pe care le puteți utiliza:

Notă: Înainte de a instala instrumentul, trebuie să aveți NPM instalat pe computer. Dacă nu o aveți, vă invit să urmează site-ul oficial (vă va ajuta să instalați Node și NPM).

Pentru a instala pachetul pe computer, tastați următoarea comandă în terminal.

$ npm install generate-changelog -g 

Odată ce faceți acest lucru, este instalat!

Cum să-l folosească

Pentru ca acest pachet să funcționeze, trebuie să urmați instrucțiunile pentru utilizarea acestui model – „tip (categorie): descriere [flags]”. În acest exemplu, voi folosi depozitul Angular.js GitHub.

Acum puteți introduce comanda generate în terminalul dvs. din depozitul GitHub.

$ changelog generate

Un fișier „CHANGELOG.md” va fi creat automat și completat cu jurnalele dvs. într-un format de reducere.

Puteți găsi mai jos un exemplu de ieșire (cu un cititor de reducere, cum ar fi GitHub).

1611575526 513 Un ghid pentru incepatori pentru Git Ce este un
Jurnal de schimbări generat automat cu instrumentul de generare a modificărilor

Concluzie

Sper că ți-a plăcut acest ghid și acum înțelegi cum să creezi un jurnal de schimbări pentru proiectul tău. Cred că este o modalitate bună de a demonstra de ce ar trebui să scrieți mesaje de comitere bune.

Simțiți-vă liber să încercați alte generatoare de registre de schimbări și să-mi trimiteți rezultatul!

Dacă aveți întrebări sau feedback, vă rugăm să ne anunțați.

Nu ratați conținutul urmărindu-mă Stare de nervozitate și Instagram.

Puteți găsi alte articole de genul acesta pe site-ul meu: herewecode.io.

Vreau mai mult?

  • În fiecare săptămână primiți o ofertă motivațională cu câteva sfaturi, un scurt tutorial în câteva diapozitive și o imagine a dezvoltatorului Instagram.
  • Înscrieți-vă la buletinul informativ și primiți cele mai recente articole, cursuri, tutoriale, sfaturi, cărți, motivație și alt conținut exclusiv.