feat: ensure url doesn't have version. upgrade version#67
Conversation
WalkthroughThis update modifies build and environment configuration files. The Maven project version and artifact naming are updated, and a new Ant plugin execution is added for property file cleanup. Several environment-specific properties files are deleted, while logging and JWT properties are added or adjusted in remaining configuration files. A JBoss deployment descriptor is introduced. Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant Maven
participant AntrunPlugin
participant FileSystem
Developer->>Maven: Run build (package/install)
Maven->>AntrunPlugin: Execute during process-resources
AntrunPlugin->>FileSystem: Concatenate property files
AntrunPlugin->>FileSystem: Delete ${source-properties} file (clean-property-files)
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
src/main/environment/ecd_ci.properties (1)
25-25: Add clarity for logging property precedence.
You’ve introducedlogging.path=logs/abovelogging.file.name. For consistency with other environment files, consider adding a comment such as:# If both logging.path and logging.file.name are set, only logging.file.name takes effect.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (8)
pom.xml(3 hunks)src/main/environment/ecd_ci.properties(1 hunks)src/main/environment/ecd_dev.properties(0 hunks)src/main/environment/ecd_example.properties(1 hunks)src/main/environment/ecd_test.properties(0 hunks)src/main/environment/ecd_uat.properties(0 hunks)src/main/resources/application.properties(0 hunks)src/main/webapp/WEB-INF/jboss-web.xml(1 hunks)
💤 Files with no reviewable changes (4)
- src/main/environment/ecd_dev.properties
- src/main/environment/ecd_uat.properties
- src/main/resources/application.properties
- src/main/environment/ecd_test.properties
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyze (java)
🔇 Additional comments (6)
src/main/webapp/WEB-INF/jboss-web.xml (1)
1-4: Context-root declaration for JBoss deployment is correct.
The newjboss-web.xmlsets the context root to/ecd-api, aligning with the goal of having a versionless URL. Ensure this matches your routing configuration and that no version token is injected at runtime.src/main/environment/ecd_example.properties (1)
24-26: Logging configuration is well-documented.
The comment and the added properties (logging.path,logging.file.name) clearly define where logs are stored. This matches best practices for environment-specific settings.pom.xml (4)
14-14: Bump project version to 3.1.0.
The version has been correctly updated from0.0.1to3.1.0. Ensure downstream modules or CI pipelines referencing the old version are updated accordingly.
16-16: Capitalize project name.
Changing<name>toECD-APIimproves readability in generated artifacts and documentation. This aligns with the artifactId and version naming convention.
252-252: Use dynamic finalName for artifact.
Switching to${artifactId}-${version}makes the final WAR filename reflect the current version automatically. This is a good practice.
339-352: Verify property-file cleanup execution.
The new Ant run execution (clean-property-files) deletes the source properties after concatenation. Maven processes executions in declaration order, so this should work. Please confirm that:
${source-properties}points to the correct file intarget/classes.- No later build steps depend on the original source properties file.
| springdoc.api-docs.enabled=true | ||
| springdoc.swagger-ui.enabled=true | ||
|
|
||
| jwt.secret=my-32-character-ultra-secure-and-ultra-long-secret |
There was a problem hiding this comment.
Avoid committing real secrets in example configs.
The example file contains a concrete JWT secret. Replace it with a clear placeholder (e.g., YOUR_JWT_SECRET_HERE) and document that a real secret must be provided during deployment to prevent accidental exposure.
🤖 Prompt for AI Agents
In src/main/environment/ecd_example.properties at line 23, replace the concrete
JWT secret value with a clear placeholder like YOUR_JWT_SECRET_HERE. Add a
comment or note indicating that a real secret must be provided during deployment
to avoid accidental exposure of sensitive information.
|
Summary by CodeRabbit
New Features
Configuration