Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Hint empty releases to the index template file #37

Closed
vy opened this issue Feb 23, 2023 · 1 comment
Closed

Hint empty releases to the index template file #37

vy opened this issue Feb 23, 2023 · 1 comment
Assignees
@vy
Labels
feature
Milestone
0.3.0

Comments

@vy
Copy link
Member

vy commented Feb 23, 2023

It can be confusing for users in the generated index.adoc to list releases without any changes in them. This becomes a problem in particular when new releases are made. Consider Log4j has just released version 2.20.0 and users expect /release-notes/index.html to show 2.20.0 at the top. Whereas, 2.x.x takes the top spot and its content is practically empty. To mitigate this, the dictionary passed to the index template file (i.e., .index.adoc.ftl) can be enriched with a boolean empty field and users can decide whether to disclose empty releases or not.
vy added a commit that referenced this issue Feb 23, 2023
@vy
Add changelogEntryCount field to the model passed to `.index.adoc.f…
750277d 
…tl` (#37)
@vy
Copy link
Member Author

vy commented Feb 23, 2023

Fixed in 750277d.

@vy vy closed this as completed Feb 23, 2023
@vy vy added this to the 0.3.0 milestone Feb 23, 2023
@vy vy self-assigned this Sep 29, 2023
@vy vy added the feature label Sep 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@vy vy

Labels
feature
Projects
None yet
Milestone
0.3.0
Development

No branches or pull requests
1 participant
@vy