elastic/logstash

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

Open

#8.114 geöffnet am 31. Aug. 2017

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Ruby (14.197 Stars) (3.496 Forks)batch import
docs infragood first issuehacktoberfest

Beschreibung

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:

Contributor Guide

Tech Stack
rubyshell
Domain
documentationbackenddevops
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
RubyRakeGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60
Research-Richtung
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.