Skip to content

fix(workflow-templates): use GitHub-recognized categories#30

Merged
dkastl merged 1 commit into
mainfrom
fix/workflow-template-categories
May 19, 2026
Merged

fix(workflow-templates): use GitHub-recognized categories#30
dkastl merged 1 commit into
mainfrom
fix/workflow-template-categories

Conversation

@dkastl

@dkastl dkastl commented May 19, 2026

Copy link
Copy Markdown
Contributor

Summary

Both Publish Backstage TechDocs and Secret Leak Check (per PR) had `categories` defined, but GitHub's workflow-template UI silently dropped the badge because the values were not in the recognized set.

Template Was Now
secret-leak-check `["Security"]` `["Code scanning"]`
publish-techdocs `["Documentation"]` `["Deployment"]`

The recognized set per actions/starter-workflows is: Automation, Code scanning, Continuous integration, Deployment, Pages.

Test plan

  • After merge, refresh https://github.com//actions/new — both templates should now show their category badge alongside the other three.

Summary by CodeRabbit

  • Chores
    • Updated categorization for workflow templates. The "Publish TechDocs" workflow is now categorized as Deployment, and the secret-leak-check workflow is now categorized as Code scanning for improved organization.

Review Change Stack

The workflow-template UI in github.com/new only renders a category
badge for categories from the recognized set (Automation, Code
scanning, Continuous integration, Deployment, Pages). "Security" and
"Documentation" silently produce no badge.

- secret-leak-check: Security -> Code scanning
- publish-techdocs:  Documentation -> Deployment

Display names now match the others (CDK Deploy Monitor, Geolonia
Release, Sync Team Access).
@coderabbitai

coderabbitai Bot commented May 19, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 7ba340b2-446e-4bfa-850a-8554b9c84503

📥 Commits

Reviewing files that changed from the base of the PR and between d84693e and b67ab62.

📒 Files selected for processing (2)
  • workflow-templates/publish-techdocs.properties.json
  • workflow-templates/secret-leak-check.properties.json

Walkthrough

This PR updates workflow template categorization metadata in two configuration files. The "Publish Backstage TechDocs" template moves from Documentation to Deployment, while the secret leak checker moves from Security to Code scanning. Both changes are single-line category field updates in JSON property files.

Changes

Workflow Template Categories

Layer / File(s) Summary
Template categorization updates
workflow-templates/publish-techdocs.properties.json, workflow-templates/secret-leak-check.properties.json
categories metadata updated in both workflow templates: TechDocs template reclassified from Documentation to Deployment; secret-leak-check template reclassified from Security to Code scanning.

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title clearly and concisely describes the main change: updating workflow template categories to use GitHub-recognized values instead of invalid ones.
Description check ✅ Passed The pull request description is comprehensive, includes a summary section with a helpful table explaining the changes, provides context about GitHub's recognized categories, and includes a test plan.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/workflow-template-categories

Comment @coderabbitai help to get the list of available commands and usage tips.

@dkastl dkastl merged commit 60fa5aa into main May 19, 2026
1 check passed
@dkastl dkastl deleted the fix/workflow-template-categories branch May 19, 2026 04:47
dkastl added a commit that referenced this pull request May 19, 2026
…gating (#37)

Setting the category to `Code scanning` in a workflow-template's
properties.json file makes GitHub mark the template as "Requires
GitHub Advanced Security" in the New Workflow picker (visible on
private repos without a GHAS license).

The secret leak scanner here does not depend on GHAS at all -- it
runs betterleaks in a regular ubuntu-latest job and posts plain
GitHub Actions annotations -- so the gating banner is misleading and
discourages adoption.

Switch to `Automation`, which renders a badge in the picker (matching
Geolonia Release and Sync Team Access) and has no feature gating.
Regression from #30.
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.

1 participant