elastic/logstash

Expand `rake version:sync` to also update asciidoc variables and the README.md

Open

Aperta il 31 ago 2017

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Ruby (14.197 star) (3496 fork)batch import
docs infragood first issuehacktoberfest

Descrizione

Update the documentation and the readme file is done manually by a human and this is error prone. We already have a rake task that take care of updating the version of the gems and also the dependencies requirements called rake version:sync.

We can expand this task to also take care of updating the following:

Guida contributor

Tech stack
rubyshell
Dominio
documentationbackenddevops
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 hours
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
fresh
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
RubyRakeGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60
Direzione di ricerca
The issue requires extending the existing `rake version:sync` task to also update asciidoc shared variables in docs/index shared1.asciidoc and version links in README.md. First, find the current implementation of `rake version:sync` in the Rakefile or lib/tasks. Then, identify the asciidoc variable file and README.md sections that contain version numbers. Modify the task to parse and update those files accordingly. The comment thread may provide guidance on expected format and how version numbers are currently managed.