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

feat: config cleanup finalize #1657

Merged
merged 16 commits into from
Jan 31, 2024
Merged

feat: config cleanup finalize #1657

merged 16 commits into from
Jan 31, 2024

Conversation

takb
Copy link
Contributor

@takb takb commented Jan 30, 2024

Pull Request Checklist

  • 1. I have rebased the latest version of the main branch into my feature branch and all conflicts
    have been resolved.
  • 2. I have added information about the change/addition to functionality to the CHANGELOG.md file under the
    [Unreleased] heading.
  • 3. I have documented my code using JDocs tags.
  • 4. I have removed unnecessary commented out code, imports and System.out.println statements.
  • 5. I have written JUnit tests for any new methods/classes and ensured that they pass.
  • 6. I have created API tests for any new functionality exposed to the API.
  • 7. If changes/additions are made to the ors-config.json file, I have added these to the ors config documentation
    along with a short description of what it is for, and documented this in the Pull Request (below).
  • 8. I have built graphs with my code of the Heidelberg.osm.gz file and run the api-tests with all test passing
  • 9. I have referenced the Issue Number in the Pull Request (if the changes were from an issue).
  • 10. For new features or changes involving building of graphs, I have tested on a larger dataset
    (at least Germany), and the graphs build without problems (i.e. no out-of-memory errors).
  • 11. For new features or changes involving the graphbuilding process (i.e. changing encoders, updating the
    importer etc.), I have generated longer distance routes for the affected profiles with different options
    (avoid features, max weight etc.) and compared these with the routes of the same parameters and start/end
    points generated from the current live ORS.
    If there are differences then the reasoning for these MUST be documented in the pull request.
  • 12. I have written in the Pull Request information about the changes made including their intended usage
    and why the change was needed.
  • 13. For changes touching the API documentation, I have tested that the API playground renders correctly.

Fixes # .

Information about the changes

  • Key functionality added:
  • Reason for change:

Examples and reasons for differences between live ORS routes, and those generated from this pull request

Required changes to ors config (if applicable)

takb and others added 2 commits January 29, 2024 17:04
…rs-config.yml

This feature intents to keep the application.yml and the ors-config.yml in sync. The ors-config.yml is intented as a minimal working configuration for users that want an up and running system without configuration. The in-depth configs are still in the ors-config.yml but commented out. The sync script will make sure in a workflow that if the original application.yml changes, the ors-config.yml mirrors the new changes but commented out.
Copy link
Contributor

@sfendrich sfendrich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few minor issues.

.github/utils/config_rewrite.sh Outdated Show resolved Hide resolved
.github/utils/config_rewrite.sh Outdated Show resolved Hide resolved
.github/utils/config_rewrite.sh Outdated Show resolved Hide resolved
.github/utils/config_rewrite.sh Outdated Show resolved Hide resolved
ors-api/ors-config.yml Outdated Show resolved Hide resolved
@takb takb changed the title Feat/config cleanup finalize feat: config cleanup finalize Jan 30, 2024
MichaelsJP and others added 10 commits January 30, 2024 14:01
The workflow is triggered on PRs for main and releases/** branches if the PR is set for review or synchronized.
Some prior changes got overwritten. This introduces the old state as well as an additional testing if the config is actually in the right format to be parsed.
To allow a smooth conversion of the application.yml the source_file parameter needs to be next after engine:. Else, awk operations will just become unnecessary tedious.
@takb takb enabled auto-merge January 30, 2024 15:05
Copy link
Contributor

@sfendrich sfendrich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thank you.

MichaelsJP and others added 3 commits January 31, 2024 11:56
The old dockerfile was coined to use the json config. This commit just makes sure everything works again. The whole setup will probably get a revamp before release anyways
@takb takb merged commit ef05700 into main Jan 31, 2024
17 checks passed
@takb takb deleted the feat/config-cleanup-finalize branch January 31, 2024 11:38
@MichaelsJP MichaelsJP added this to the V8 Release milestone Mar 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
No open projects
Status: Awaiting release
Development

Successfully merging this pull request may close these issues.

3 participants