Skip to content

docs: Add JDK prerequisite documentation #5

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

Merged
seqradev merged 1 commit into from
Jan 26, 2026
Merged

docs: Add JDK prerequisite documentation #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 28 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ Run [Seqra](https://github.com/seqra/seqra) static analysis in your CI, generate

> **Note:** The action expects **Linux x86\_64** runners.

### Prerequisites

Seqra analyzes compiled bytecode of your project. Before running this action, ensure your CI environment is configured to compile the project. For example:

- **Java/Kotlin projects:** Set up a JDK using `actions/setup-java@v5`

### Quick Start

### Scan
Expand All @@ -21,7 +27,13 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout your repository
uses: actions/checkout@v4
uses: actions/checkout@v6

- name: Set up JDK
uses: actions/setup-java@v5
with:
distribution: 'temurin'
java-version: '21'

- name: Run Seqra code analysis
uses: seqra/seqra-action@v2
Expand All @@ -45,7 +57,13 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout your repository
uses: actions/checkout@v4
uses: actions/checkout@v6

- name: Set up JDK
uses: actions/setup-java@v5
with:
distribution: 'temurin'
java-version: '21'

- name: Run Seqra code analysis
uses: seqra/seqra-action@v2
Expand All @@ -72,7 +90,13 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout your repository
uses: actions/checkout@v4
uses: actions/checkout@v6

- name: Set up JDK
uses: actions/setup-java@v5
with:
distribution: 'temurin'
java-version: '21'

- name: Run Seqra code analysis
uses: seqra/seqra-action@v2
Expand Down Expand Up @@ -127,6 +151,7 @@ After the job completes, you’ll find:

## Troubleshooting

* **"Compilation has failed:"** Seqra needs to compile your project to analyze bytecode. Ensure you have set up the required build tools (e.g., JDK via `actions/setup-java@v5`) before running this action. See [Prerequisites](#prerequisites).
* **Monorepos:** You can analyze only the project you need using `project-root`.
* **Timeouts:** If the scan times out, increase `timeout` (e.g., `30m`).

Expand Down