[CHORE] Add Overture issue template and field sync workflow - #474
Draft
Eric Godwin (ericgodwin) wants to merge 1 commit into
Draft
[CHORE] Add Overture issue template and field sync workflow#474Eric Godwin (ericgodwin) wants to merge 1 commit into
Eric Godwin (ericgodwin) wants to merge 1 commit into
Conversation
Adds .github/ISSUE_TEMPLATE/overture.yaml (Type, Scope, Skillset, Description), config.yml disabling blank issues, and the sync-issue-type-and-scope workflow that populates the org-level fields from the form answers. Closes #473 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: ericgodwin <eric@overturemaps.org>
Super-linter summary
Super-linter detected linting errors For more information, see the GitHub Actions workflow run Powered by Super-linter NATURAL_LANGUAGE |
🗺️ OMF Docs previews are live!
Auto-gen schema site is now available. This is an early preview of a future workflow where we will automatically generate and publish reference docs for the Overture Maps Format schema. The auto-gen schema site may contain incomplete or inaccurate information as we are still refining the generation process, so please compare against the repo schema site and refer to the official Overture documentation for authoritative information. Note ♻️ This preview updates automatically with each push to this PR. |
This file contains hidden or 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
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.
Closes #473
Summary
OvertureMaps/docshad no.github/ISSUE_TEMPLATE/directory — every issue was filed blank. This adds the standard Overture issue form plus the org field sync workflow, matching tf-data-platform (OvertureMaps/tf-data-platform#4623, OvertureMaps/tf-data-platform#4728).Changes
.github/ISSUE_TEMPLATE/overture.yaml— the single Overture template. Adds new issues to theOvertureproject (OvertureMaps/84) and prompts for:Type:Task,Bug,Agenda(noFeature)Scope:Addresses,Base,Buildings,Divisions,Places,Transportation,Multi-theme or PlatformSkillset:data analysis,data science,dev ops,engineeringDescriptiontextareaAll four fields are required, and no dropdown has a
default:— nothing is pre-selected. The template does not prepend a bracketed type to the issue title..github/ISSUE_TEMPLATE/config.yml—blank_issues_enabled: false..github/workflows/sync-issue-type-and-scope.yml— runsOvertureMaps/workflows/.github/actions/sync-issue-fields@mainonissues: openedto copy the form answers into the org-level fields.No templates were removed — there were none to remove.
Design pivots
overture.yamlandconfig.ymlare byte-identical to tf-data-platform. The workflow needed small adjustments to pass this repo's stricter lint bar (uvx zizmor --persona=pedanticreported four findings against the tf-data-platform copy):---document marker, matching the other workflows in this repopermissions: {}(fixesexcessive-permissions)name: Sync Fieldsto the job (fixesanonymous-definition)issues: write(fixesundocumented-permissions)The
# zizmor: ignore[unpinned-uses]on the@mainaction reference is carried over from tf-data-platform — the shared action is intentionally tracked atmain.Testing
uvx zizmor --persona=pedantic .github/workflows/sync-issue-type-and-scope.yml→No findings to report. Good job! (1 ignored)Post-merge verification (per the issue's test plan): confirm the template renders in the "New issue" chooser, that required-field validation blocks submission with an unselected dropdown, that the blank-issue option is gone, and that a test issue lands in the
Overtureproject withType/Scope/Skillsetpopulated by the sync workflow.Operational impact
New issues in this repo must go through the form. Existing issues are unaffected.