Removing need for new_problem.yaml to avoid ugly failing on default#150
Removing need for new_problem.yaml to avoid ugly failing on default#150CIGbalance wants to merge 4 commits intomainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR aims to make the “new problem” submission check more robust by avoiding failures when utils/new_problem.yaml is missing, while also updating contributor guidance and cleaning up the template configuration.
Changes:
- Adjust GitHub Actions triggers/conditions for the new-problem validation workflow.
- Add a “new problem” example to
utils/README.md. - Remove the template entry from
utils/new_problem.yaml(file is now removed in this branch).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
utils/README.md |
Adds an example snippet for contributors submitting new problems. |
utils/new_problem.yaml |
Removes the template content (file no longer present after the change). |
.github/workflows/new_problem_check.yml |
Limits push triggering to main and skips the validation step if utils/new_problem.yaml is absent. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
kvdblom
left a comment
There was a problem hiding this comment.
Some small things, main thing is to update the instructions. There are also the AI comments, some appear like they might make sense.
There was a problem hiding this comment.
The :alert: tags don't seem to render when previewing this: https://github.com/OpenOptimizationOrg/OPL/blob/3535ab500a7863081cb8e35bd7933bed6197939a/utils/README.md
utils/README.md
Outdated
There was a problem hiding this comment.
Should these instructions change now that the file is removed? Explain that they have to create it from the example below?
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Updated example problem format from JSON to YAML.
This pull request updates the workflow for checking new problem submissions and improves related documentation and configuration. The main changes are focused on making the workflow more robust and providing better examples for contributors.
Workflow improvements:
.github/workflows/new_problem_check.yml) now only runs on pushes to themainbranch / pull requests and only ifutils/new_problem.yamlhas changed, reducing unnecessary workflow runs.utils/new_problem.yamlexists, preventing errors when the file is missing.Documentation and configuration updates:
utils/README.mdto help contributors format their submissions correctly.utils/new_problem.yamlto keep the configuration clean and avoid accidental submissions of the template.