Modificare automaticamente la Wiki da una pipeline YAML con Azure DevOps

di Matteo Tumiati, in DevOps,

Concludiamo questa serie dedicata alla creazione automatica delle note di rilascio con Azure DevOps parlando di come gestire le note una volta create, considerando la pipeline e gli script visti negli episodi precedenti. Come avevamo annunciato, abbiamo creato con successo un file di markdown contenente le release notes adatto per la pubblicazione nella Wiki: questo è comodo per tenere tutto a portata di mano all'interno del team, ma anche per poter esportare facilmente in altri formati (tipo PDF), a persone esterne al team di sviluppo.

Il primo passaggio da fare consiste nel convertire (se non è già stato fatto) la Wiki in "Wiki as Code", così da avere un repository git per la Wiki. In questo modo potremo intervenire dalle pipeline per caricare e modificare file esattamente come facciamo normalmente sul repository contenente il codice sorgente delle applicazioni, ovvero tramite i comandi di git.

Prima di vedere i comandi, però, dobbiamo assicurarci che la pipeline faccia il checkout di entrambi i repository, quello corrente dove la pipeline risiede e quello della Wiki appena creato.

steps:
- checkout: self
- checkout: git://MyTeam/Wiki@main
  persistCredentials: true

Chiaramente il nome del progetto, del repository contenente la Wiki e il nome del branch dipende dalla configurazione che si è scelto. A questo punto non dobbiamo fare altro che copiare le release notes generate localmente nella folder che contiene la Wiki:

Copy-Item $(Build.SourcesDirectory)/Changes.md $(Build.SourcesDirectory)/Wiki/Release-notes/Changes.md

Poichè il file poi dovrà essere univoco nel tempo (se lanciamo la pipeline ogni volta che eseguiamo una nuova release), converrà sostituire il nome con un parametro per renderlo dinamico (es. il numero di versione oppure la data).

A questo punto dobbiamo configurare git per poter fare il push delle modifiche nel repository della Wiki. Questo è possibile impostando dei parametri "finti" come lo username e la mail. Il push vero e proprio a livello di remote sarà possibile poichè avremo impostato al momento del checkout la proprietà persistCredentials per la Wiki.

cd $(Build.SourcesDirectory)/Wiki/Release-notes
git config --global user.email "release-diff@myteam.com"
git config --global user.name "MyTeam Bot"

Infine, possiamo lanciare i soliti comandi di git per fare un commit e il successivo push per trovarcelo sul remote (e quindi sulla Wiki):

git add .
git commit -m "Azure DevOps wiki updated"
git push origin HEAD:main --force

Commenti

Visualizza/aggiungi commenti

| Condividi su: Twitter, Facebook, LinkedIn

Per inserire un commento, devi avere un account.

Fai il login e torna a questa pagina, oppure registrati alla nostra community.

Approfondimenti

I più letti di oggi