Skip to content

Commit 354e4d2

Browse files
committed
comment out old release workflow
1 parent 5ffa3dd commit 354e4d2

File tree

2 files changed

+80
-0
lines changed

2 files changed

+80
-0
lines changed

AGENTS.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Repository Guidelines
2+
3+
## Project Structure & Modules
4+
- Root is a Maven multi-module project using the Maven Wrapper (`mvnw`).
5+
- Modules: `core` (library), `cli` (fat-jar CLI), `maven` (Maven plugin), `maven-example` (plugin usage example).
6+
- Tests live under `<module>/src/test/java`, with fixtures in `<module>/src/test/resources` (e.g., `core/src/test/resources`).
7+
8+
## Build, Test, and Run
9+
- Build all modules: `./mvnw clean package`
10+
- Run tests only: `./mvnw test`
11+
- Format code: `./mvnw fmt:format` (runs pre-commit via githook as well)
12+
- CLI jar (shaded): `cli/target/openapi-diff-cli-<version>-all.jar`
13+
- Example run: `java -jar cli/target/openapi-diff-cli-2.2.0-SNAPSHOT-all.jar old.yaml new.yaml --markdown diff.md`
14+
- Docker (optional): `docker build -t local-openapi-diff .` then run as shown in README.
15+
16+
## Coding Style & Naming
17+
- Language: Java 8 (`maven.compiler.source/target=1.8`).
18+
- Formatter: Google Java Format via `fmt-maven-plugin` (use `./mvnw fmt:format`; do not hand-wrap).
19+
- Packages: `org.openapitools.openapidiff...`
20+
- Tests: JUnit 5; name classes `*Test.java` and use clear method names (Given_When_Then optional).
21+
22+
## Testing Guidelines
23+
- Framework: JUnit Jupiter (5.x); assertions via AssertJ.
24+
- Run module tests: `./mvnw -pl <module> -am test`
25+
- Coverage: JaCoCo agent is configured; keep or improve coverage around changed code.
26+
- Add minimal, focused tests near the change (unit in `core`, integration/usage in `cli` or `maven`).
27+
28+
## Commit & Pull Request Guidelines
29+
- Style: Conventional Commits (e.g., `feat(core): add schema diff`, `fix(cli): handle empty URLs`, `build(deps): bump junit-bom`).
30+
- Message: imperative, concise subject (<72 chars), details in body; reference issues (e.g., `Fixes #123`).
31+
- PRs: include a clear summary, scope/module, reasoning, and before/after behavior; link issues; include CLI examples or output snippets when relevant.
32+
- CI must pass; run `./mvnw fmt:format test package` locally before opening PR.
33+
34+
## Security & Configuration
35+
- Prefer local files for specs during tests; avoid fetching remote URLs in unit tests.
36+
- CLI supports `--config-file` and `--config-prop` to override defaults; include sample configs in tests when adding new checks.

qodana.yaml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
#-------------------------------------------------------------------------------#
2+
# Qodana analysis is configured by qodana.yaml file #
3+
# https://www.jetbrains.com/help/qodana/qodana-yaml.html #
4+
#-------------------------------------------------------------------------------#
5+
version: "1.0"
6+
7+
#Specify inspection profile for code analysis
8+
profile:
9+
name: qodana.starter
10+
11+
#Enable inspections
12+
#include:
13+
# - name: <SomeEnabledInspectionId>
14+
15+
#Disable inspections
16+
#exclude:
17+
# - name: <SomeDisabledInspectionId>
18+
# paths:
19+
# - <path/where/not/run/inspection>
20+
21+
projectJDK: "21" #(Applied in CI/CD pipeline)
22+
23+
#Execute shell command before Qodana execution (Applied in CI/CD pipeline)
24+
#bootstrap: sh ./prepare-qodana.sh
25+
26+
#Install IDE plugins before Qodana execution (Applied in CI/CD pipeline)
27+
#plugins:
28+
# - id: <plugin.id> #(plugin id can be found at https://plugins.jetbrains.com)
29+
30+
# Quality gate. Will fail the CI/CD pipeline if any condition is not met
31+
# severityThresholds - configures maximum thresholds for different problem severities
32+
# testCoverageThresholds - configures minimum code coverage on a whole project and newly added code
33+
# Code Coverage is available in Ultimate and Ultimate Plus plans
34+
#failureConditions:
35+
# severityThresholds:
36+
# any: 15
37+
# critical: 5
38+
# testCoverageThresholds:
39+
# fresh: 70
40+
# total: 50
41+
42+
#Qodana supports other languages, for example, Python, JavaScript, TypeScript, Go, C#, PHP
43+
#For all supported languages see https://www.jetbrains.com/help/qodana/linters.html
44+
linter: jetbrains/qodana-jvm-community:2025.2

0 commit comments

Comments
 (0)