Skip to content

[CHORE] Add Overture issue template and field sync workflow - #474

Draft
Eric Godwin (ericgodwin) wants to merge 1 commit into
mainfrom
ericgodwin-ericg-473-add-issue-templates
Draft

[CHORE] Add Overture issue template and field sync workflow#474
Eric Godwin (ericgodwin) wants to merge 1 commit into
mainfrom
ericgodwin-ericg-473-add-issue-templates

Conversation

@ericgodwin

Copy link
Copy Markdown

Closes #473

Summary

OvertureMaps/docs had 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 the Overture project (OvertureMaps/84) and prompts for:

    • Type: Task, Bug, Agenda (no Feature)
    • Scope: Addresses, Base, Buildings, Divisions, Places, Transportation, Multi-theme or Platform
    • Skillset: data analysis, data science, dev ops, engineering
    • Description textarea

    All 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.ymlblank_issues_enabled: false.

  • .github/workflows/sync-issue-type-and-scope.yml — runs OvertureMaps/workflows/.github/actions/sync-issue-fields@main on issues: opened to copy the form answers into the org-level fields.

No templates were removed — there were none to remove.

Design pivots

overture.yaml and config.yml are byte-identical to tf-data-platform. The workflow needed small adjustments to pass this repo's stricter lint bar (uvx zizmor --persona=pedantic reported four findings against the tf-data-platform copy):

  • added the leading --- document marker, matching the other workflows in this repo
  • added top-level permissions: {} (fixes excessive-permissions)
  • added name: Sync Fields to the job (fixes anonymous-definition)
  • added an explanatory comment on issues: write (fixes undocumented-permissions)

The # zizmor: ignore[unpinned-uses] on the @main action reference is carried over from tf-data-platform — the shared action is intentionally tracked at main.

Testing

  • uvx zizmor --persona=pedantic .github/workflows/sync-issue-type-and-scope.ymlNo findings to report. Good job! (1 ignored)
  • All three files parse as valid YAML.

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 Overture project with Type / Scope / Skillset populated by the sync workflow.

Operational impact

New issues in this repo must go through the form. Existing issues are unaffected.

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>
@github-actions

Copy link
Copy Markdown

Super-linter summary

Language Validation result
JAVASCRIPT_ES Pass ✅
MARKDOWN Pass ✅
NATURAL_LANGUAGE Fail ❌
SQLFLUFF Pass ✅

Super-linter detected linting errors

For more information, see the GitHub Actions workflow run

Powered by Super-linter

NATURAL_LANGUAGE

/github/workspace/docs/schema/reference/base/infrastructure.md
  48:74  ✓ error  Incorrect term: “Key/value”, use “Key-value” instead  terminology

/github/workspace/docs/schema/reference/base/land.md
  58:74  ✓ error  Incorrect term: “Key/value”, use “Key-value” instead  terminology

/github/workspace/docs/schema/reference/base/land_use.md
  53:74  ✓ error  Incorrect term: “Key/value”, use “Key-value” instead  terminology

/github/workspace/docs/schema/reference/base/types/source_tags.md
  3:1  ✓ error  Incorrect term: “Key/value”, use “Key-value” instead  terminology

/github/workspace/docs/schema/reference/base/water.md
  69:74  ✓ error  Incorrect term: “Key/value”, use “Key-value” instead  terminology

/github/workspace/docs/schema/reference/places/place.md
  40:89  ✓ error  Incorrect term: “websites”, use “sites” instead  terminology

/github/workspace/docs/schema/reference/system/ref/id.md
  1:3  ✓ error  Incorrect term: “Id”, use “ID” instead  terminology

/github/workspace/docs/schema/reference/system/snake_case_string.md
  3:28  ✓ error  Incorrect term: “snake case”, use “snake_case” instead  terminology
  9:38  ✓ error  Incorrect term: “snake case”, use “snake_case” instead  terminology

✖ 9 problems (9 errors, 0 warnings, 0 infos)
✓ 9 fixable problems.
Try to run: $ textlint --fix [file]

@github-actions

Copy link
Copy Markdown

🗺️ OMF Docs previews are live!

🆕 Auto-gen schema site (beta) https://staging.overturemaps.org/docs/pr/474/index.html
🗂️ Auto-gen schema ref main@e2c017b
🌍 Repo schema site https://staging.overturemaps.org/docs/pr/474-no-autogen/index.html
🕐 Updated Aug 10, 2026 19:38 UTC
📝 Commit 3f35a42

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.

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.

Add standard Overture issue template and field sync workflow

1 participant