mirror of
https://github.com/Stirling-Tools/Stirling-PDF.git
synced 2025-08-21 19:59:24 +00:00
chore: update development configs, formatting tools, and CI enhancements (#4130)
# Description of Changes - **What was changed** - Bumped `java.format.settings.google.version` to **1.28.0** in `.devcontainer/devcontainer.json` and `.vscode/settings.json`. - Expanded ignore patterns in `.devcontainer/devcontainer.json` to cover `app/core/`, `app/common/`, `app/proprietary/` directories. - Added a new top‐level `.dockerignore` to exclude build artifacts, virtual environments, logs, OS files, and markdown docs. - Consolidated EditorConfig YAML globs into `*.{yml,yaml}` to remove duplication. - Fixed missing newline in `.github/config/.files.yaml` and added label metadata (`from_name`/`description`) in `.github/labels.yml`. - Updated `build.gradle`: - Introduced `junitPlatformVersion = "1.12.2"` and replaced hard-coded launcher versions. - Applied the `jacoco` plugin across all subprojects and configured `jacocoTestReport` (XML + HTML). - Wire-up `jacocoTestReport` to run after tests. - **Why the change was made** - Ensure all formatting tools (Google Java Format) stay in sync across editors and containers. - Clean up ignore rules to prevent build artifacts and sensitive files from creeping into images and repos. - Improve CI visibility by generating code-coverage reports with JaCoCo. - Keep GitHub configuration files well-formed and enrich label definitions for automation. --- ## Checklist ### General - [x] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [x] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md) (if applicable) - [x] I have performed a self-review of my own code - [x] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md#6-testing) for more details.
This commit is contained in:
parent
bb8edffaab
commit
b6ff1dd7f6
@ -49,7 +49,7 @@
|
|||||||
"java.configuration.updateBuildConfiguration": "interactive",
|
"java.configuration.updateBuildConfiguration": "interactive",
|
||||||
"java.format.enabled": true,
|
"java.format.enabled": true,
|
||||||
"java.format.settings.profile": "GoogleStyle",
|
"java.format.settings.profile": "GoogleStyle",
|
||||||
"java.format.settings.google.version": "1.26.0",
|
"java.format.settings.google.version": "1.28.0",
|
||||||
"java.format.settings.google.extra": "--aosp --skip-sorting-imports --skip-javadoc-formatting",
|
"java.format.settings.google.extra": "--aosp --skip-sorting-imports --skip-javadoc-formatting",
|
||||||
"java.saveActions.cleanup": true,
|
"java.saveActions.cleanup": true,
|
||||||
"java.cleanup.actions": [
|
"java.cleanup.actions": [
|
||||||
@ -79,9 +79,17 @@
|
|||||||
".venv*/",
|
".venv*/",
|
||||||
".vscode/",
|
".vscode/",
|
||||||
"bin/",
|
"bin/",
|
||||||
|
"app/core/bin/",
|
||||||
|
"app/common/bin/",
|
||||||
|
"app/proprietary/bin/",
|
||||||
"build/",
|
"build/",
|
||||||
|
"app/core/build/",
|
||||||
|
"app/common/build/",
|
||||||
|
"app/proprietary/build/",
|
||||||
"configs/",
|
"configs/",
|
||||||
|
"app/core/configs/",
|
||||||
"customFiles/",
|
"customFiles/",
|
||||||
|
"app/core/customFiles/",
|
||||||
"docs/",
|
"docs/",
|
||||||
"exampleYmlFiles",
|
"exampleYmlFiles",
|
||||||
"gradle/",
|
"gradle/",
|
||||||
@ -93,6 +101,9 @@
|
|||||||
".git-blame-ignore-revs",
|
".git-blame-ignore-revs",
|
||||||
".gitattributes",
|
".gitattributes",
|
||||||
".gitignore",
|
".gitignore",
|
||||||
|
"app/core/.gitignore",
|
||||||
|
"app/common/.gitignore",
|
||||||
|
"app/proprietary/.gitignore",
|
||||||
".pre-commit-config.yaml"
|
".pre-commit-config.yaml"
|
||||||
],
|
],
|
||||||
"java.signatureHelp.enabled": true,
|
"java.signatureHelp.enabled": true,
|
||||||
|
@ -31,18 +31,12 @@ indent_size = 2
|
|||||||
# CSS files typically use an indent size of 2 spaces for better readability and alignment with community standards.
|
# CSS files typically use an indent size of 2 spaces for better readability and alignment with community standards.
|
||||||
indent_size = 2
|
indent_size = 2
|
||||||
|
|
||||||
[*.yaml]
|
[*.{yml,yaml}]
|
||||||
# YAML files use an indent size of 2 spaces to maintain consistency with common YAML formatting practices.
|
# YAML files use an indent size of 2 spaces to maintain consistency with common YAML formatting practices.
|
||||||
indent_size = 2
|
indent_size = 2
|
||||||
insert_final_newline = false
|
insert_final_newline = false
|
||||||
trim_trailing_whitespace = false
|
trim_trailing_whitespace = false
|
||||||
|
|
||||||
[*.yml]
|
|
||||||
# YML files follow the same conventions as YAML files, using an indent size of 2 spaces.
|
|
||||||
indent_size = 2
|
|
||||||
insert_final_newline = false
|
|
||||||
trim_trailing_whitespace = false
|
|
||||||
|
|
||||||
[*.json]
|
[*.json]
|
||||||
# JSON files use an indent size of 2 spaces, which is the standard for JSON formatting.
|
# JSON files use an indent size of 2 spaces, which is the standard for JSON formatting.
|
||||||
indent_size = 2
|
indent_size = 2
|
||||||
|
5
.github/labels.yml
vendored
5
.github/labels.yml
vendored
@ -42,6 +42,7 @@
|
|||||||
- name: "Front End"
|
- name: "Front End"
|
||||||
color: "BBD2F1"
|
color: "BBD2F1"
|
||||||
description: "Issues or pull requests related to front-end development"
|
description: "Issues or pull requests related to front-end development"
|
||||||
|
from_name: "frontend"
|
||||||
- name: "github-actions"
|
- name: "github-actions"
|
||||||
description: "Pull requests that update GitHub Actions code"
|
description: "Pull requests that update GitHub Actions code"
|
||||||
color: "999999"
|
color: "999999"
|
||||||
@ -77,6 +78,7 @@
|
|||||||
- name: "Translation"
|
- name: "Translation"
|
||||||
color: "9FABF9"
|
color: "9FABF9"
|
||||||
from_name: "translation"
|
from_name: "translation"
|
||||||
|
description: "Issues or pull requests related to translation"
|
||||||
- name: "upstream"
|
- name: "upstream"
|
||||||
color: "DEDEDE"
|
color: "DEDEDE"
|
||||||
- name: "v2"
|
- name: "v2"
|
||||||
@ -178,3 +180,6 @@
|
|||||||
- name: "pr-deployed"
|
- name: "pr-deployed"
|
||||||
color: "00FF00"
|
color: "00FF00"
|
||||||
description: "Pull request has been deployed to a test environment"
|
description: "Pull request has been deployed to a test environment"
|
||||||
|
- name: "codex"
|
||||||
|
color: "ededed"
|
||||||
|
description: "chatgpt AI generated code"
|
3
.vscode/settings.json
vendored
3
.vscode/settings.json
vendored
@ -2,6 +2,7 @@
|
|||||||
"editor.wordSegmenterLocales": "",
|
"editor.wordSegmenterLocales": "",
|
||||||
"editor.guides.bracketPairs": "active",
|
"editor.guides.bracketPairs": "active",
|
||||||
"editor.guides.bracketPairsHorizontal": "active",
|
"editor.guides.bracketPairsHorizontal": "active",
|
||||||
|
"editor.defaultFormatter": "EditorConfig.EditorConfig",
|
||||||
"cSpell.enabled": false,
|
"cSpell.enabled": false,
|
||||||
"[feature]": {
|
"[feature]": {
|
||||||
"editor.defaultFormatter": "alexkrechik.cucumberautocomplete"
|
"editor.defaultFormatter": "alexkrechik.cucumberautocomplete"
|
||||||
@ -40,7 +41,7 @@
|
|||||||
"java.configuration.updateBuildConfiguration": "interactive",
|
"java.configuration.updateBuildConfiguration": "interactive",
|
||||||
"java.format.enabled": true,
|
"java.format.enabled": true,
|
||||||
"java.format.settings.profile": "GoogleStyle",
|
"java.format.settings.profile": "GoogleStyle",
|
||||||
"java.format.settings.google.version": "1.27.0",
|
"java.format.settings.google.version": "1.28.0",
|
||||||
"java.format.settings.google.extra": "--aosp --skip-sorting-imports --skip-javadoc-formatting",
|
"java.format.settings.google.extra": "--aosp --skip-sorting-imports --skip-javadoc-formatting",
|
||||||
// (DE) Aktiviert Kommentare im Java-Format.
|
// (DE) Aktiviert Kommentare im Java-Format.
|
||||||
// (EN) Enables comments in Java formatting.
|
// (EN) Enables comments in Java formatting.
|
||||||
|
16
build.gradle
16
build.gradle
@ -30,6 +30,7 @@ ext {
|
|||||||
openSamlVersion = "4.3.2"
|
openSamlVersion = "4.3.2"
|
||||||
commonmarkVersion = "0.25.1"
|
commonmarkVersion = "0.25.1"
|
||||||
googleJavaFormatVersion = "1.28.0"
|
googleJavaFormatVersion = "1.28.0"
|
||||||
|
junitPlatformVersion = "1.12.2"
|
||||||
tempJrePath = null
|
tempJrePath = null
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -82,6 +83,7 @@ subprojects {
|
|||||||
apply plugin: 'com.diffplug.spotless'
|
apply plugin: 'com.diffplug.spotless'
|
||||||
apply plugin: 'org.springframework.boot'
|
apply plugin: 'org.springframework.boot'
|
||||||
apply plugin: 'io.spring.dependency-management'
|
apply plugin: 'io.spring.dependency-management'
|
||||||
|
apply plugin: 'jacoco'
|
||||||
|
|
||||||
java {
|
java {
|
||||||
// 17 is lowest but we support and recommend 21
|
// 17 is lowest but we support and recommend 21
|
||||||
@ -125,7 +127,7 @@ subprojects {
|
|||||||
|
|
||||||
testImplementation 'org.springframework.boot:spring-boot-starter-test'
|
testImplementation 'org.springframework.boot:spring-boot-starter-test'
|
||||||
testRuntimeOnly 'org.mockito:mockito-inline:5.2.0'
|
testRuntimeOnly 'org.mockito:mockito-inline:5.2.0'
|
||||||
testRuntimeOnly 'org.junit.platform:junit-platform-launcher:1.12.2'
|
testRuntimeOnly "org.junit.platform:junit-platform-launcher:$junitPlatformVersion"
|
||||||
}
|
}
|
||||||
|
|
||||||
tasks.withType(JavaCompile).configureEach {
|
tasks.withType(JavaCompile).configureEach {
|
||||||
@ -139,6 +141,16 @@ subprojects {
|
|||||||
|
|
||||||
test {
|
test {
|
||||||
useJUnitPlatform()
|
useJUnitPlatform()
|
||||||
|
finalizedBy jacocoTestReport
|
||||||
|
}
|
||||||
|
|
||||||
|
jacocoTestReport {
|
||||||
|
dependsOn test
|
||||||
|
reports {
|
||||||
|
xml.required.set(true)
|
||||||
|
csv.required.set(false)
|
||||||
|
html.required.set(true)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
tasks.named("processResources") {
|
tasks.named("processResources") {
|
||||||
@ -556,7 +568,7 @@ dependencies {
|
|||||||
}
|
}
|
||||||
|
|
||||||
testImplementation 'org.springframework.boot:spring-boot-starter-test'
|
testImplementation 'org.springframework.boot:spring-boot-starter-test'
|
||||||
testRuntimeOnly 'org.junit.platform:junit-platform-launcher:1.12.2'
|
testRuntimeOnly "org.junit.platform:junit-platform-launcher:$junitPlatformVersion"
|
||||||
}
|
}
|
||||||
|
|
||||||
tasks.named("test") {
|
tasks.named("test") {
|
||||||
|
Loading…
x
Reference in New Issue
Block a user