-
Notifications
You must be signed in to change notification settings - Fork 45
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.
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
Improve ODE Configuration and Revise Release Process Documentation #567
Merged
dan-du-car
merged 19 commits into
usdot-jpo-ode:release/2025-q1
from
CDOT-CV:cdot-release_2025-q1
Jan 27, 2025
Merged
Improve ODE Configuration and Revise Release Process Documentation #567
dan-du-car
merged 19 commits into
usdot-jpo-ode:release/2025-q1
from
CDOT-CV:cdot-release_2025-q1
Jan 27, 2025
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…o-deduplicator projects
Co-authored-by: Michael7371 <[email protected]>
Co-authored-by: Michael7371 <[email protected]>
Co-authored-by: Michael7371 <[email protected]>
Co-authored-by: Michael7371 <[email protected]>
…ce in step 3 of jpo-geojsonconverter quarterly release process
…tially-by-project' of github.com:CDOT-CV/jpo-ode into docs/revise-quarterly-release-process-to-proceed-sequentially-by-project
…elease_process_quarterly.md` to implement suggestions
…figs chore: add env vars to docker-compose.yml and defaults to sample.env
…ocess-to-proceed-sequentially-by-project Revised the quarterly release workflow to proceed sequentially by project
dan-du-car
approved these changes
Jan 27, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Details
Description
This PR introduces two key updates:
Environment Variable Configuration for ODE:
Previously, the environment variables configuring the ODE were not included in the sample.env or docker-compose.yml files. While these variables have default values in the code and the application ran as expected, their absence made it less straightforward for users to identify available configuration options. This update adds the environment variables to the respective files, improving clarity and ease of configuration for users.
Release Process Documentation Update:
The current release process documentation takes a collective approach, where all projects progress through the steps of code readiness, preliminary testing, project reference updates, release creation, and DockerHub image testing simultaneously. However, this approach causes issues due to interdependencies between projects. To address this, the release process has been updated to execute all four stages individually for each project—one at a time—resolving interdependency challenges and ensuring a smoother release workflow.
These changes enhance usability and streamline project management processes.
Related Issue
N/A
Motivation and Context
This PR improves usability by clarifying ODE configuration options through updated environment variable documentation. It also resolves interdependency issues in the release workflow by revising the process to handle each project individually, ensuring smoother and more reliable releases.
How Has This Been Tested?
N/A
Types of changes
Checklist:
ODE Contributing Guide