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.

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

Optionally rate artifact-reference-checker:unify check as warning #27

Closed
kaklakariada opened this issue Nov 13, 2023 · 3 comments
Closed
Labels
feature Product feature

Comments

@kaklakariada
Copy link
Collaborator

kaklakariada commented Nov 13, 2023

PJ reported a use case in which the developer didn't plan to do a release immediately (for example when updating CI files) but bump the version in the .pom file so the current documentation file for the current changes (changelog) doesn't get overwritten.

After that PK forces to update the documentation references to this future version, thus referencing a yet unreleased version.

Problem

References to a yet unreleased version might be confusing or wrong towards customers.

Proposed mitigation

Reference checker should check if the release date in the latest changelog file is defined or not:

  • If the changelog contains a concrete date (e.g. # Project Keeper 2.9.16, released 2023-11-13), work as normal
  • If the changelog contains a dummy date (e.g. # Project Keeper 2.9.16, released 2023-??-??), reference checker logs a warning and does nothing
@pj-spoelders
Copy link

pj-spoelders commented Nov 22, 2023

Thanks chipi! I like the proposed solution

@pj-spoelders
Copy link

pj-spoelders commented Mar 22, 2024

Another idea is to add a flag/option that can be set for the maven plugin in the configuration section, like it's done here: spotify/fmt-maven-plugin#153
At the moment to run project-keeper:fix when there's already a release of the current version you have to increase the version already. This is also not ideal but I guess this won't change. TBD'd.

@redcatbear
Copy link
Contributor

People, please keep unreleased changes to a acceptable minimum, then we can live with the inconsistency. I am going to close this ticket. I understand where it comes from, but there are so many things that have priority over this issue.

@redcatbear redcatbear closed this as not planned Won't fix, can't repro, duplicate, stale Jun 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Product feature
Projects
None yet
Development

No branches or pull requests

3 participants