rochacbruno/python-project-template

HISTORY.md newest position is called (unreleased)

Open

#18 geöffnet am 18. Feb. 2022

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Makefile (184 Forks)github user discovery
bughelp wanted

Repository-Metriken

Stars
 (1.224 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

When making a new release, HISTORY.md newest position is called (unreleased) instead of the newest version.

I've created a simple workaround by modifying release under Makefile.

Instead of calling:

@$(ENV_PREFIX)gitchangelog  > HISTORY.md

You could perhaps do something like:

@$(ENV_PREFIX)gitchangelog | sed "s/(unreleased)/$${TAG} ($$(date +%Y-%m-%d))/g" > HISTORY.md

Furthermore, you could get rid of all the release commits from changelog:

@$(ENV_PREFIX)gitchangelog | sed "s/(unreleased)/$${TAG} ($$(date +%Y-%m-%d))/g" | grep -v "Release: version" > HISTORY.md

This way HISTORY.md contains relevant commits only.

Contributor Guide

Research-Richtung
Ändern Sie das Makefile, um '(unreleased)' in HISTORY.md durch den aktuellen Versions Tag und das Datum zu ersetzen, und entfernen Sie optional Release Commits aus dem Changelog.
Tech Stack
python
Domain
devops
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80