https://github.com/advanced-security/delombok

Delombok Java Code for analysis with Code Scanning
https://github.com/advanced-security/delombok

Last synced: 3 months ago
JSON representation

Delombok Java Code for analysis with Code Scanning

• Host: GitHub
• URL: https://github.com/advanced-security/delombok
• Owner: advanced-security
• License: apache-2.0
• Created: 2022-11-10T09:50:46.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-09-18T17:06:33.000Z (about 1 year ago)
• Last Synced: 2024-04-14T11:43:01.084Z (7 months ago)
• Language: Python
• Size: 16.6 KB
• Stars: 1
• Watchers: 1
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-codeql - delombok - Delombok Java Code for analysis with Code Scanning (deprecated - now [supported by CodeQL](https://github.blog/changelog/2023-09-01-code-scanning-with-codeql-improves-support-for-java-codebases-that-use-project-lombok/)) (CodeQL Actions Helpers)

README

        
>**⚠️ Note:** CodeQL `2.14.4+` (GitHub Enterprise Server `3.11+`) now [natively supports Java codebases that use Project Lombok](https://github.blog/changelog/2023-09-01-code-scanning-with-codeql-improves-support-for-java-codebases-that-use-project-lombok/).  Use this action for legacy configurations.

# delombok GitHub action

Inspired by https://github.com/lcartey/delombok-action

The above action works great for most repositories. Unfortunately, it fails to delombok certain versions of the source code of [WebGoat](https://github.com/WebGoat/WebGoat). The action in this repository uses a similar technique and additionally tries to guard against those error conditions.

After the delombok process, the action tries to format the resulting Java files such that they look as close to the original files as possible. That way GitHub Code Scanning will be able to extract and analyze the files and the results are likely to be displayed correctly.

## Usage

Run the delombok action before CodeQL `github/codeql-action/autobuild` action or before the code is compiled (maven, graddle,...) in case you are not using autobuild.

```

- uses: advanced-security/delombok@v1

```