Skip to content

Commit 1dad1ba

Browse files
authored
chore: update logback to 1.4.14 (#336)
* chore: update logback to 1.4.14 Update logback to 1.4.14 to address: https://avd.aquasec.com/nvd/2023/cve-2023-6378/ Add library updating guide and expand existing details in CONTRIBUTING.md Fixes #335 * chore: ignore errors on docker hub link Docker hub is rate limiting GitHub sources causing 429 errors when running megalinter, resulting in test failures so adding this URL to .lycheeignore to avoid this failure.
1 parent 7ee8a97 commit 1dad1ba

File tree

10 files changed

+85
-12
lines changed

10 files changed

+85
-12
lines changed

.lycheeignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
https://www.linkedin.com/in/steven-hartland-a7435b4/
1+
https://www.linkedin.com/in/steven-hartland-a7435b4/
2+
https://hub.docker.com/r/nvuillam/npm-groovy-lint

CHANGELOG.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,14 @@
22

33
## UNRELEASED
44

5+
- Update logback to 1.4.14 to address [cve-2023-6378](https://avd.aquasec.com/nvd/2023/cve-2023-6378/)
6+
57
## [13.0.0] 2023-11-26
68

79
- **BREAKING CHANGE: Upgrade CodeNarc to v3.4.0-alpha+3346775f**
810

911
- Major core architecture refactoring by the great [**Steven Hartland**](https://github.com/stevenh)
10-
12+
1113
- Fix files specified on the command line not linting as expected due to the generated patterns not working as intended if relative path that contains a file and not a directory due to an issue with CodeNarc pattern processing.
1214

1315
- Fix incompatible arguments passed to CodeNarc by:

CONTRIBUTING.md

Lines changed: 76 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,87 @@
11
<!-- markdownlint-disable MD013 MD033 MD034 -->
22
# Contributing
33

4-
Contributions are very welcome !
4+
Contributions are very welcome!
55

6-
Instructions :
6+
## Setup
77

8-
- Fork the repository and clone it on your computer
9-
- Install dependencies: `npm install`
10-
- Link npm package bundle: `npm link`
11-
- Update source code and add mocha tests for any code you create
12-
- Run `npm run lint:fix` then `npm run test` to check your updates didn't break anything
13-
- Once your code is ready, documented and tested, please make a [pull request](https://github.com/nvuillam/npm-groovy-lint/pulls) :)
8+
If you're a new contributor, first you need
9+
[Fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
10+
and [clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
11+
it on your computer.
12+
13+
Next you need to install the npm dependencies and link the bundle:
14+
15+
```shell
16+
npm install
17+
npm link
18+
```
19+
20+
Now you have an local development install of npm-groovy-lint, you can make changes.
21+
22+
## Testing
23+
24+
If you have added new features or fixed an issue please make sure that you add
25+
tests to validate your changes.
26+
27+
To test your code run:
28+
29+
```shell
30+
npm run test
31+
```
32+
33+
Once your code is ready, documented and tested, run following to ensure your
34+
the code is linted and fully built and then submit a
35+
[pull request](https://github.com/nvuillam/npm-groovy-lint/pulls).
36+
37+
```shell
38+
npm run dev:pre-commit
39+
```
40+
41+
## VsCode Groovy Lint Testing
1442

1543
If you need to test your updates in VsCode Groovy Lint before making your PR
1644

1745
- Fork [VsCode Groovy Lint repo](https://github.com/nvuillam/vscode-groovy-lint) and clone it on your computer (with same root as your clone of npm-groovy-lint fork)
1846
- Run `npm run dev:lint-install-local-copy-vscode` to deploy your local updates to VsCode Groovy Lint extension development files
1947
- Launch VsCode Groovy Lint debug configuration `Groovy Lint Debug`
48+
49+
## Updating Libraries
50+
51+
To update libraries download the new jar files into the correct place:
52+
53+
- [Java libraries](lib/java/)
54+
- [Groovy libraries](lib/java/groovy/lib/)
55+
56+
Once you have the new jars run the following to regenerate the new server jar:
57+
58+
```shell
59+
npm run dev:pre-commit
60+
```
61+
62+
## Troubleshooting
63+
64+
If [GitHub Action - Update check](https://github.com/nvuillam/npm-groovy-lint/actions/workflows/lint.yml)
65+
reports changes for [lib/java/CodeNarcServer.jar](lib/java/CodeNarcServer.jar)
66+
make sure you have run:
67+
68+
```shell
69+
npm run dev:pre-commit
70+
```
71+
72+
If this has been run ensure you're running **exactly** the same version of node
73+
as the GitHub Action, as different node versions can impact how [zlib](https://www.zlib.net/)
74+
compresses the data in the jar file.
75+
76+
To do determine the node version look at the output from the
77+
`Check for changes -> Install node`. For example in the following output node
78+
`18.18.2` is in use.
79+
80+
```text
81+
Run actions/setup-node@v3
82+
Found in cache @ /opt/hostedtoolcache/node/18.18.2/x64
83+
Environment details
84+
```
85+
86+
You can use [nvm](https://github.com/nvm-sh/nvm) to switch easily between
87+
different node versions.

docs/CHANGELOG.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,14 @@
22

33
## UNRELEASED
44

5+
- Update logback to 1.4.14 to address [cve-2023-6378](https://avd.aquasec.com/nvd/2023/cve-2023-6378/)
6+
57
## [13.0.0] 2023-11-26
68

79
- **BREAKING CHANGE: Upgrade CodeNarc to v3.4.0-alpha+3346775f**
810

911
- Major core architecture refactoring by the great [**Steven Hartland**](https://github.com/stevenh)
10-
12+
1113
- Fix files specified on the command line not linting as expected due to the generated patterns not working as intended if relative path that contains a file and not a directory due to an issue with CodeNarc pattern processing.
1214

1315
- Fix incompatible arguments passed to CodeNarc by:

groovy/src/main/MANIFEST.MF

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ Class-Path: CodeNarc-3.4.0-alpha+3346775f.jar GMetrics-2.1.0.jar groov
55
-3.0.9.jar groovy/lib/groovy-cli-commons-3.0.9.jar groovy/lib/groovy-
66
dateutil-3.0.9.jar groovy/lib/groovy-json-3.0.9.jar groovy/lib/groovy
77
-templates-3.0.9.jar groovy/lib/groovy-xml-3.0.9.jar logback-classic-
8-
1.4.9.jar logback-core-1.4.9.jar slf4j-api-2.0.9.jar
8+
1.4.14.jar logback-core-1.4.14.jar slf4j-api-2.0.9.jar
99
Created-By: 1.8.0_144 (Oracle Corporation)
1010
Main-Class: com.nvuillam.CodeNarcServer

lib/java/CodeNarcServer.jar

2 Bytes
Binary file not shown.

lib/java/logback-classic-1.4.14.jar

277 KB
Binary file not shown.

lib/java/logback-classic-1.4.9.jar

-275 KB
Binary file not shown.

lib/java/logback-core-1.4.14.jar

583 KB
Binary file not shown.

lib/java/logback-core-1.4.9.jar

-587 KB
Binary file not shown.

0 commit comments

Comments
 (0)