Enable checking git diffs for modifying "frozen" areas by koppor · Pull Request #146 · nbbrd/heylogs

koppor · 2023-09-12T14:16:49Z

The check feature now contains a check if during an update of the CHANGELOG.md file, areas of released versions are touched.
For instance, a contributor starts a pull request and adds their change to CHANGELOG.md.
Then, the main branch is released.
Now, the PR should move the changelog entry to the new [unreleased] section.
Therefore, heylogs warns in case there are modifications inside blocks of released versions.
One has to enable this check explicitly by the -g command line parameter.

I had to include JGit as dependency. Therefore, the minimum Java requirement is Java 11. I think, this is OK, because Java 17 should be available at most systems.

I use the multiline string feature in the tests, therefore, the tests are Java 17.

Since I wanted to output some debug information, I added tinylog as logging framework. The main reason is that Logger.debug can be used without any instantiation. - The logging traffic of JGit is routed to tinylog.

Example output:

   112:1  error  Change in a released version  releasechangesfrozen
   253:1  error  Change in a released version  releasechangesfrozen
   400:1  error  Change in a released version  releasechangesfrozen
   427:1  error  Change in a released version  releasechangesfrozen
   507:1  error  Change in a released version  releasechangesfrozen
   554:1  error  Change in a released version  releasechangesfrozen
   738:1  error  Change in a released version  releasechangesfrozen
   881:1  error  Change in a released version  releasechangesfrozen
  1125:1  error  Missing ref link              all-h2-contain-a-version
  1000:1  error  Change in a released version  releasechangesfrozen

Due to the way of visiting the Markdown tree, errors in the last block come as very last. I can fix this in a follow-up work, because I think, this issue occurs very seldom - and is just a "UX" issue.

- Upgrade to Java 11 (tests: Java 17) - Add JGit as dependency - Add tinylog as logging framework

koppor · 2023-09-13T09:13:22Z

There is a "simpler" way with the keepac CLI tool. Explained at NiclasvanEyk/keepac#20 (comment).

Even though, I very like the Java eco system, I am OK to use a go-based tool + jq to solve my issue.

charphi · 2023-09-13T12:09:13Z

There is a "simpler" way with the keepac CLI tool. Explained at NiclasvanEyk/keepac#20 (comment).

I was not aware of this tool. Lots of good ideas in there.

charphi · 2023-09-13T12:15:49Z

Regarding the migration to Java11+, I need to do some research first.

My problem is that most of the tools created in this organisation are support tools for a larger project that needs to run on Java8.
There is a new version of this large project that requires Java17, but the old one has not yet reached its end of life.

Fortunately, I already have a workaround in mind, but I need to test it to make sure it works properly.

koppor · 2023-10-22T08:07:29Z

Fortunately, I already have a workaround in mind, but I need to test it to make sure it works properly.

Did you find some workaround? If not, maybe, "just" implementing a "toJson()" functionality (as clparse offers) would suffice to support the feature. (clparse -> json -> filter -> dif)

# Conflicts: # CHANGELOG.md # heylogs-cli/src/main/java/nbbrd/heylogs/cli/CheckCommand.java

koppor · 2023-10-22T13:12:52Z

The CLI maybe needs more thought.

check --gitdiff CHANGELOG.md

Results in

Invalid value for option '--gitdiff': cannot convert 'CHANGELOG.md' to Pair (java.lang.IllegalArgumentException: Invalid commit range format! Expected format is id1...id2.)

I have been in the rabbit whole of Picoli for that. = versus space for sub command beloging. I don't remember excactly now, but I wanted to share this now ^^.

koppor · 2023-10-22T18:03:15Z

The CLI maybe needs more thought.

check CHANGELOG.md --gitdiff

Works, so maybe, leave as is ^^

(I could not come up with a better word for gitdiff)

koppor · 2023-10-22T18:25:15Z

I could not manage to have errors properly output. Maybe you have an idea?

2023-10-22 20:19:10 [main] internal.heylogs.GitDiffRule.initialize()
ERROR: Could not read from git repository

check C:\git-repositories\jabref\CHANGELOG.md --debug --gitdiff main...non-valid-ref

# Conflicts: # CHANGELOG.md # heylogs-api/src/main/java/nbbrd/heylogs/Version.java

charphi · 2023-11-10T14:05:02Z

I'm still thinking about this gitdiff feature.
I like to keep the project simple and any git feature brings complexity and a few dependencies.
And there is the Java version problem ...
My workaround is cumbersome and would require a lot of work so I prefer not to.

Anyway, I have a few solutions:

export the markdown to json as clparse does
create a plugin that contains gitdiff specific code so the base API is still Java 8 while the new feature is Java 11. The plugin would be added at runtime. This could also solve the "Check for dots as separation" issue.

koppor · 2023-11-10T21:12:24Z

The latest merge of development branch broke this functionality. Too much effort to maintain. Exporting to JSON is the better way!

koppor · 2023-11-14T23:42:04Z

I finally made the switch to clparse (for this use case) at JabRef/jabref#10641. So, no need to think through this use-case further.

(just for information: clparse needed to be changed to support "my" CHANGELOG files ^^ -- marcaddeo/clparse#22)

koppor added 2 commits September 12, 2023 16:13

Enable checking git diffs for modifying "frozen" areas

914d6c2

- Upgrade to Java 11 (tests: Java 17) - Add JGit as dependency - Add tinylog as logging framework

Fix forbiddenapis warning

34c84eb

koppor mentioned this pull request Sep 13, 2023

Check enforcer plugin without cache #139

Closed

charphi added the enhancement New feature or request label Sep 13, 2023

koppor mentioned this pull request Oct 21, 2023

Add check for frozen CHANGELOG.md sections JabRef/jabref#10537

Merged

6 tasks

koppor mentioned this pull request Oct 22, 2023

Support non-semVer colindean/keepachangelog-parser-java#17

Open

Merge remote-tracking branch 'upstream/develop' into add-git-diff-check

a72a89d

# Conflicts: # CHANGELOG.md # heylogs-cli/src/main/java/nbbrd/heylogs/cli/CheckCommand.java

koppor mentioned this pull request Oct 22, 2023

Add git diff check koppor/heylogs#1

Open

koppor added 2 commits October 22, 2023 20:06

Fix NPE

ad3219d

Throw exception on non-valid references

446bc30

koppor added 2 commits November 8, 2023 14:32

Merge remote-tracking branch 'upstream/develop' into add-git-diff-check

bb3a133

Merge commit '2e8f' into add-git-diff-check

8bbe5e4

# Conflicts: # CHANGELOG.md # heylogs-api/src/main/java/nbbrd/heylogs/Version.java

charphi mentioned this pull request Nov 10, 2023

Add import/export markdown format from/to json format #174

Closed

koppor mentioned this pull request Nov 10, 2023

Adapt tests to new heylogs JabRef/jabref#10631

Merged

6 tasks

koppor closed this Nov 10, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable checking git diffs for modifying "frozen" areas#146

Enable checking git diffs for modifying "frozen" areas#146
koppor wants to merge 7 commits into
nbbrd:developfrom
koppor:add-git-diff-check

koppor commented Sep 12, 2023 •

edited

Loading

Uh oh!

koppor commented Sep 13, 2023

Uh oh!

charphi commented Sep 13, 2023

Uh oh!

charphi commented Sep 13, 2023

Uh oh!

koppor commented Oct 22, 2023

Uh oh!

koppor commented Oct 22, 2023

Uh oh!

koppor commented Oct 22, 2023

Uh oh!

koppor commented Oct 22, 2023

Uh oh!

charphi commented Nov 10, 2023

Uh oh!

koppor commented Nov 10, 2023

Uh oh!

koppor commented Nov 14, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

koppor commented Sep 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

koppor commented Sep 13, 2023

Uh oh!

charphi commented Sep 13, 2023

Uh oh!

charphi commented Sep 13, 2023

Uh oh!

koppor commented Oct 22, 2023

Uh oh!

koppor commented Oct 22, 2023

Uh oh!

koppor commented Oct 22, 2023

Uh oh!

koppor commented Oct 22, 2023

Uh oh!

charphi commented Nov 10, 2023

Uh oh!

koppor commented Nov 10, 2023

Uh oh!

koppor commented Nov 14, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

koppor commented Sep 12, 2023 •

edited

Loading