mirror of
https://github.com/Stirling-Tools/Stirling-PDF.git
synced 2025-07-23 21:55:21 +00:00
eb7f5e57cc
# Description of Changes - **What was changed** - Updated `.github/labeler-config-srvaroa.yml` to match the new `devGuide/.*` patterns instead of the old `HowToAddNewLanguage.md` - Modified `.github/pull_request_template.md` to point to `devGuide/DeveloperGuide.md` and `devGuide/HowToAddNewLanguage.md` for the Developer Guide and translation-tags sections - Updated the SSO link in `README.md` to point to the 'Single Sign-On Configuration' section on docs.stirlingpdf.com instead of the outdated Enterprise Edition page - Changed the relative link in `devGuide/DeveloperGuide.md` to use `../CONTRIBUTING.md` for consistency - Added a new `devGuide/EXCEPTION_HANDLING_GUIDE.md` to document standard exception-handling patterns and internationalisation best practices - Updated `devGuide/README.md` index to reflect the new location and naming conventions for development guides - **Why the change was made** - To centralise all development documentation under a single `devGuide` directory for better organisation and discoverability. - To ensure that GitHub labeler rules and PR templates correctly reference the new file structure. - To introduce a clear, project-wide guide on exception handling, improving consistency across Java, JavaScript, HTML/CSS, and Python components. Closes #3799 --- ## 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/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/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/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/DeveloperGuide.md#6-testing) for more details.
143 lines
3.9 KiB
YAML
143 lines
3.9 KiB
YAML
version: 1
|
|
labels:
|
|
|
|
- label: "Bugfix"
|
|
title: '^fix:.*'
|
|
|
|
- label: "enhancement"
|
|
title: '^feat:.*'
|
|
|
|
- label: "build"
|
|
title: '^build:.*'
|
|
|
|
- label: "chore"
|
|
title: '^chore:.*'
|
|
|
|
- label: "ci"
|
|
title: '^ci:.*'
|
|
|
|
- label: "perf"
|
|
title: '^perf:.*'
|
|
|
|
- label: "refactor"
|
|
title: '^refactor:.*'
|
|
|
|
- label: "revert"
|
|
title: '^revert:.*'
|
|
|
|
- label: "style"
|
|
title: '^style:.*'
|
|
|
|
- label: "Documentation"
|
|
title: '^docs:.*'
|
|
|
|
- label: 'API'
|
|
title: '.*openapi.*'
|
|
|
|
- label: 'Translation'
|
|
files:
|
|
- 'stirling-pdf/src/main/resources/messages_[a-zA-Z_]{2}_[a-zA-Z_]{2,7}.properties'
|
|
- 'scripts/ignore_translation.toml'
|
|
- 'stirling-pdf/src/main/resources/templates/fragments/languages.html'
|
|
- '.github/scripts/check_language_properties.py'
|
|
|
|
- label: 'Front End'
|
|
files:
|
|
- 'stirling-pdf/src/main/resources/templates/.*'
|
|
- 'proprietary/src/main/resources/templates/.*'
|
|
- 'stirling-pdf/src/main/resources/static/.*'
|
|
- 'proprietary/src/main/resources/static/.*'
|
|
- 'stirling-pdf/src/main/java/stirling/software/SPDF/controller/web/.*'
|
|
- 'stirling-pdf/src/main/java/stirling/software/SPDF/UI/.*'
|
|
- 'proprietary/src/main/java/stirling/software/proprietary/security/controller/web/.*'
|
|
|
|
- label: 'Java'
|
|
files:
|
|
- 'common/src/main/java/.*.java'
|
|
- 'proprietary/src/main/java/.*.java'
|
|
- 'stirling-pdf/src/main/java/.*.java'
|
|
|
|
- label: 'Back End'
|
|
files:
|
|
- 'stirling-pdf/src/main/java/stirling/software/SPDF/config/.*'
|
|
- 'stirling-pdf/src/main/java/stirling/software/SPDF/controller/.*'
|
|
- 'stirling-pdf/src/main/resources/settings.yml.template'
|
|
- 'stirling-pdf/src/main/resources/application.properties'
|
|
- 'stirling-pdf/src/main/resources/banner.txt'
|
|
- 'scripts/png_to_webp.py'
|
|
- 'split_photos.py'
|
|
- 'application.properties'
|
|
|
|
- label: 'Security'
|
|
files:
|
|
- 'proprietary/src/main/java/stirling/software/proprietary/security/.*'
|
|
- 'scripts/download-security-jar.sh'
|
|
- '.github/workflows/dependency-review.yml'
|
|
- '.github/workflows/scorecards.yml'
|
|
|
|
- label: 'API'
|
|
files:
|
|
- 'stirling-pdf/src/main/java/stirling/software/SPDF/config/OpenApiConfig.java'
|
|
- 'stirling-pdf/src/main/java/stirling/software/SPDF/controller/web/MetricsController.java'
|
|
- 'stirling-pdf/src/main/java/stirling/software/SPDF/controller/api/.*'
|
|
- 'stirling-pdf/src/main/java/stirling/software/SPDF/model/api/.*'
|
|
- 'proprietary/src/main/java/stirling/software/proprietary/security/controller/api/.*'
|
|
- 'scripts/png_to_webp.py'
|
|
- 'split_photos.py'
|
|
- '.github/workflows/swagger.yml'
|
|
|
|
- label: 'Documentation'
|
|
files:
|
|
- '.*.md'
|
|
- 'scripts/counter_translation.py'
|
|
- 'scripts/ignore_translation.toml'
|
|
|
|
- label: 'Docker'
|
|
files:
|
|
- '.github/workflows/build.yml'
|
|
- '.github/workflows/push-docker.yml'
|
|
- 'Dockerfile'
|
|
- 'Dockerfile.fat'
|
|
- 'Dockerfile.ultra-lite'
|
|
- 'exampleYmlFiles/.*.yml'
|
|
- 'scripts/download-security-jar.sh'
|
|
- 'scripts/init.sh'
|
|
- 'scripts/init-without-ocr.sh'
|
|
- 'scripts/installFonts.sh'
|
|
- 'test.sh'
|
|
- 'test2.sh'
|
|
|
|
- label: 'Devtools'
|
|
files:
|
|
- '.devcontainer/.*'
|
|
- 'Dockerfile.dev'
|
|
- '.vscode/.*'
|
|
- '.editorconfig'
|
|
- '.pre-commit-config'
|
|
- '.github/workflows/pre_commit.yml'
|
|
- 'devGuide/.*'
|
|
|
|
- label: 'Test'
|
|
files:
|
|
- 'common/src/test/.*'
|
|
- 'proprietary/src/test/.*'
|
|
- 'stirling-pdf/src/test/.*'
|
|
- 'testing/.*'
|
|
- '.github/workflows/scorecards.yml'
|
|
- 'exampleYmlFiles/test_cicd.yml'
|
|
|
|
- label: 'Github'
|
|
files:
|
|
- '.github/.*'
|
|
|
|
- label: 'Gradle'
|
|
files:
|
|
- 'gradle/.*'
|
|
- 'gradlew'
|
|
- 'gradlew.bat'
|
|
- 'settings.gradle'
|
|
- 'build.gradle'
|
|
- 'common/build.gradle'
|
|
- 'proprietary/build.gradle'
|
|
- 'stirling-pdf/build.gradle'
|