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

Update template and checks #581

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

jmesnil
Copy link
Member

@jmesnil jmesnil commented Jun 27, 2024

  • Update the template to move the tracking issue and the stability level to the front matter
  • When a PR is open, check that these fields are valid
  • Generate a HTML page for the proposal with these fields.

This PR updates the template to be more descriptive about its expected content.

As a demo, I opened a "dummy" proposal in my fork that was missing the issue and stability-level in the front matter:

Before that PR is merged, the following labels must be created:

  • missing-issue - The analysis document is missing an issue tracker in its metadata
  • invalid-stability-level - The analysis document is missing a valid stability level in its metadata
  • stability-level/experimental - Feature is at the "Experimental" stability level
  • stability-level/preview - Feature is at the "Preview" stability level
  • stability-level/community - Feature is at the "Community" stability level
  • stability-level/default - Feature is at the "Default" stability level

@jmesnil jmesnil force-pushed the issue_stability_level_checks branch from af28396 to 98c4b6c Compare June 27, 2024 09:48
design-doc-template.adoc Outdated Show resolved Hide resolved
design-doc-template.adoc Outdated Show resolved Hide resolved
design-doc-template.adoc Outdated Show resolved Hide resolved

=== Default Configuration

__<What is the impact of this feature in the default configuration(s) provided by WildFly?>__
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that this and the following items are specific areas to consider in terms incompatibility. They are not top level items for general description.

I'd like to have a discussion somewhere about the exact meaning of this one and the "Importing Existing Configuration" one as there are relationships. And they both need to be more fully described. For example we provide standard OOTB configurations, while configuration items, used or not in those standard configs, have default values. This one should primarily be about the latter, but there are various cases to consider.

design-doc-template.adoc Outdated Show resolved Hide resolved
design-doc-template.adoc Outdated Show resolved Hide resolved
design-doc-template.adoc Outdated Show resolved Hide resolved
design-doc-template.adoc Outdated Show resolved Hide resolved
* Update the template to move the tracking issue and the stability level to the front matter
* When a PR is open, check that these fields are valid
* Generate a HTML page for the proposal with these fields.

Signed-off-by: Jeff Mesnil <[email protected]>
@jmesnil jmesnil force-pushed the issue_stability_level_checks branch from 98c4b6c to 0824288 Compare July 3, 2024 12:11
Based on the value of the `stability-level` field in the front matter,
add a label `stability-level/xxx` to the PR.

Signed-off-by: Jeff Mesnil <[email protected]>
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.

None yet

2 participants