Feature: Robust Placeholder System and Output Formatting Engine
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 24/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- github-actions, python
- Domain
- documentation, release, tooling
Research direction
Start by reading the existing release-note placeholder/template handling, configuration, unit tests, and the related issues listed: #205, #189, #80, #78, #76, #56, and #97. The acceptance criteria define done: configurable new placeholders, prefix/postfix and row formatting, contributor/co-author placeholders, replacement mapping, edge-case unit tests, and documentation or migration guidance.
Written by the indexing model from the issue text.
Description
Feature Description
Implement a configurable, extensible placeholder system for generated release notes, supporting advanced formatting capabilities such as:
- New placeholder types (e.g., {closed-sub-issues-ratio}, custom contributors, etc.)
- User-defined prefix/postfix support and row formatting controls
- Contributor and user replacement mapping
- Chapter line formatting
Problem / Opportunity
Current formatting via placeholders is inflexible for complex workflows: users are limited in the formatting of entries, cannot always add missing context or structure, and business requirements (such as custom contributor display or new rules for entry presence/ratio) are not easily satisfied by the template system. A robust system will improve output control for a range of documentation and compliance needs.
Acceptance Criteria
- Users can add and use new placeholders in configuration.
- Formatting supports prefix, postfix, and row-level control.
- Contributors and co-authors are accessible via placeholders.
- Placeholder parsing is fully unit-tested (edge cases).
- Documentation includes usage and migration guides.
- User replacement mapping is supported in configuration.
Proposed Solution
Build a flexible parsing engine for placeholders using a config-driven grammar. Enhance documentation and provide test cases for new features. Investigate backward compatibility layer or a migration guide for breaking changes.
Dependencies / Related
#205, #189, #80, #78, #76, #56, #97
Additional Context
This feature supports a wide range of release documentation requirements and is foundational for many governance and compliance use cases.
- Dominant language
- Python
- Stars
- 13
- Forks
- 0
- Avg merge
- 1m
- Merged PRs (30d)
- 5
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from AbsaOSS/generate-release-notes
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 3/5 1-2 days Newbie friendliness 70/100
-
Difficulty 4/5 3-5 days Newbie friendliness 50/100
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
-
epic
Difficulty 5/5 Over a week Newbie friendliness 30/100
All issues in AbsaOSS/generate-release-notes
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
awslabs/visual-asset-management-system#414 ·
Maintainers usually reply within 1 day
-
bug v1 v2
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
modelcontextprotocol/python-sdk#3670 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
aicell-lab/bioengine#232 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
modelscope/evalscope#1836 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100