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

[#568] Add GitHub action to verify the front matter metadata #576

Merged
merged 1 commit into from
Jun 6, 2024

Conversation

jmesnil
Copy link
Member

@jmesnil jmesnil commented Jun 4, 2024

This fixes #568

@jmesnil
Copy link
Member Author

jmesnil commented Jun 4, 2024

@bstansberry @darranl This PR enables us to automatically validate that a proposal has valid categories in its metadata.
If that's not the case, it will add a invalid-categories label to the PR. Once this is valid, the label would be removed.

I can't provide a test case for this from this PR so I've created a temporary branch at https://github.com/wildfly/wildfly-proposals/tree/github_action_frontmatter. When I opened #575 against this temp branch, you can see the check is failing (with a clear error message at https://github.com/wildfly/wildfly-proposals/actions/runs/9362939230/job/25772708885?pr=575) and the invalid-categories label is added to the PR.

This enhancement would make sure that we have proposals with valid categories before they are merged.
The check only verifies proposals that are modified by the PR.

@darranl With this setup in place, we could expand our metadata in the front matter of the proposal to further validate that a proposal is in a good shape. For example, we could move to the front matter info such as:

  • stability-level-- validate that the stability level is set, we could use that when we generate the web site to highlight the proposal (without having to have a [EXPERIMENTAL] in the document title)
  • reviewer, outside-perspective -- these fields would point to the right people involved in the proposal
  • issue -- the issue tracker for the proposal

Having labels for these various fields would also help discoverability and community participations (what are the experimental proposals? Which proposals is missing an outside-perspective person, etc.)

@bstansberry bstansberry merged commit 1b47d85 into main Jun 6, 2024
@bstansberry
Copy link
Contributor

Thanks @jmesnil!

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 CI to validate categories
2 participants