rochacbruno/python-project-template

HISTORY.md newest position is called (unreleased)

Open

#18 opened on Feb 18, 2022

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Makefile (184 forks)github user discovery
bughelp wanted

Repository metrics

Stars
 (1,224 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

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 direction
Modify the Makefile to replace '(unreleased)' in HISTORY.md with the current version tag and date, and optionally remove release commits from the changelog.
Tech stack
python
Domain
devops
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80