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

[MS4] Modernization #2 #1706

Closed
6 tasks done
grobmeier opened this issue Aug 16, 2023 · 3 comments
Closed
6 tasks done

[MS4] Modernization #2 #1706

grobmeier opened this issue Aug 16, 2023 · 3 comments
Assignees
@grobmeier
Labels
STF-Milestones Milestones funded by the Sovereign Tech Fund

Comments

@grobmeier
Copy link
Member

grobmeier commented Aug 16, 2023 •
edited by ppkarwasz
Loading

We need to add some code formatting standards and address issues detected by multiple static analysis tools:

Code formatting standards can be addressed by:

  • Spotless

Regarding static analysis we plan to:
@grobmeier grobmeier added the STF-Milestones Milestones funded by the Sovereign Tech Fund label Aug 16, 2023
@grobmeier grobmeier self-assigned this Aug 16, 2023
@ppkarwasz
Copy link
Contributor

Reports by the three tools integrated into Github (Dependabot, CodeQL, Scorecard) have been addressed.

We can not achieve the CII-Best-Practices badge, until we introduce a dynamic analysis tool (fuzzing).

@vy vy mentioned this issue Oct 22, 2023
Closed
11 tasks
ppkarwasz added a commit that referenced this issue Oct 25, 2023
@ppkarwasz
[LOG4J-3675] Fix spring-test dependency scope
2e7c2ca 
The dependency scope of `spring-test` accidentally changed to `compile`
in version 2.21.1.

This is part of (#1706).
@ppkarwasz
Copy link
Contributor

We introduced a deterministic formatter in apache/logging-parent#59.

The process of choosing the right formatter started on September 20th in this dev thread. The choice fell on palantir-java-format, because:

  • it has an excellent Java 8 (lambdas) support (compared to google-java-format),
  • it is largely compatible with our previous Java Style Guide. Compared to the Google Java Format, it uses an indentation of 4 spaces instead of 2 spaces,
  • compared to the Eclipse Java formatter it has no formatting options. This is actually an advantage, since it prevents discussing each one of the hundreds Eclipse options. Moreover some Eclipse options render the formatting non-deterministic,
  • it provides support for both our build environment (Spotless) and IntelliJ IDEA editor,

In order to provide support for the Eclipse IDE, we ported Google's Java Format Eclipse plugin to palantir-java-format: palantir/palantir-java-format#949.

ppkarwasz added a commit to ppkarwasz/logging-log4j2 that referenced this issue Nov 20, 2023
@ppkarwasz
Use parameterized logging everywhere
734e548 
Our code should be an example to users: we should never use string
concatenation in log messages.

This was performed using OpenRewrite and is related to apache#1706.
@ppkarwasz ppkarwasz mentioned this issue Nov 20, 2023
Merged
ppkarwasz added a commit to ppkarwasz/logging-log4j2 that referenced this issue Nov 20, 2023
@ppkarwasz
Use parameterized logging everywhere
0916b55 
Our code should be an example to users: we should never use string
concatenation in log messages.

This was performed using OpenRewrite and is related to apache#1706.
ppkarwasz added a commit that referenced this issue Nov 20, 2023
@ppkarwasz
Apply OpenRewrite Java 11 migration
d5a05bd 
Apply OpenRewrite's "Migrate from Java 8 to Java 11" recipe.

This is part of #1706.
@ppkarwasz
Copy link
Contributor

After applying the Palantir formatter and all the Migrate to Java 11 (Java 11 is the currently agreed baseline for 3.x) OpenRewrite rules to the main branch, I consider this task completed.

ppkarwasz added a commit to ppkarwasz/logging-log4j2 that referenced this issue Nov 21, 2023
@ppkarwasz
Use parameterized logging everywhere
8d238bc 
Our code should be an example to users: we should never use string
concatenation in log messages.

This was performed using OpenRewrite and is related to apache#1706.
ppkarwasz added a commit that referenced this issue Nov 21, 2023
@ppkarwasz
Use parameterized logging everywhere
33deaf6 
Our code should be an example to users: we should never use string
concatenation in log messages.

This was performed using OpenRewrite and is related to #1706.
ppkarwasz added a commit that referenced this issue Nov 21, 2023
@ppkarwasz
Use parameterized logging everywhere
b6673e7 
Our code should be an example to users: we should never use string
concatenation in log messages.

This was performed using OpenRewrite and is related to #1706.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@grobmeier grobmeier

Labels
STF-Milestones Milestones funded by the Sovereign Tech Fund
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@grobmeier @ppkarwasz