Skip to content
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
merged 19 commits into from
Jan 27, 2025

Conversation

dmccoystephenson
Copy link
Collaborator

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

  • Defect fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that cause existing functionality to change)
  • Documentation

Checklist:

  • I have added any new packages to the sonar-scanner.properties file
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
    ODE Contributing Guide
  • I have added tests to cover my changes.
  • All new and existing tests passed.

mcook42 and others added 19 commits January 23, 2025 09:54
…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 dan-du-car merged commit ac20958 into usdot-jpo-ode:release/2025-q1 Jan 27, 2025
3 checks passed
@dmccoystephenson dmccoystephenson deleted the cdot-release_2025-q1 branch January 28, 2025 18:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants