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

Create a GitHub action to check PR title #4002

Open
varodrig opened this issue Feb 14, 2025 · 8 comments · May be fixed by #4018
Open

Create a GitHub action to check PR title #4002

varodrig opened this issue Feb 14, 2025 · 8 comments · May be fixed by #4018
Assignees
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@varodrig
Copy link
Contributor

Create a GitHub action that will check the PR title to make sure it aligns with the rules

The rules are:

component_name: description

For example:
pipelines: Fixed broken link in Getting Started with Kubeflow Pipelines
website: Fixed style issues on main page

List of components/areas:

Requested by @andreyvelich in regards of PR #3965

@andreyvelich
Copy link
Member

/good-first-issue

Copy link

@andreyvelich:
This request has been marked as suitable for new contributors.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.

In response to this:

/good-first-issue

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@google-oss-prow google-oss-prow bot added good first issue Good for newcomers help wanted Extra attention is needed labels Feb 14, 2025
@thesuperzapper
Copy link
Member

People might be able to use the one we created for kubeflow/notebooks:

But I am not sure what the valid list of {semantic_prefix}: should be, because there are PRs which affect content, and there are PRs that affect the website itself, like #3981

@pboyd
Copy link
Contributor

pboyd commented Feb 24, 2025

I'd be happy to take a crack at this. The semantic PR action looks like it could be coerced into doing what's needed, but this action looks like it was intended to do exactly what's requested here.

Is this a sufficient list for the allowed component names?

  • central-dash
  • katib
  • model-registry
  • notebooks
  • pipelines
  • spark-operator
  • trainer
  • website

These are the directory names under content/en/docs/components with a catch-all (website) for anything that doesn't fit. Thoughts?

@varodrig
Copy link
Contributor Author

I'd be happy to take a crack at this. The semantic PR action looks like it could be coerced into doing what's needed, but this action looks like it was intended to do exactly what's requested here.

Is this a sufficient list for the allowed component names?

  • central-dash
  • katib
  • model-registry
  • notebooks
  • pipelines
  • spark-operator
  • trainer
  • website

These are the directory names under content/en/docs/components with a catch-all (website) for anything that doesn't fit. Thoughts?

Thanks @pboyd for looking into this. You can see the full list of components's name here
https://raw.githubusercontent.com/kubeflow/website/refs/heads/master/.github/ISSUE_TEMPLATE/BUG_REPORT.md

@vikas-saxena02 vikas-saxena02 linked a pull request Feb 25, 2025 that will close this issue
2 tasks
@vikas-saxena02
Copy link
Contributor

vikas-saxena02 commented Feb 25, 2025

@varodrig I have done a PR #4018 for this. Please review.

@pboyd
Copy link
Contributor

pboyd commented Feb 25, 2025

I didn't see #4018 in time. I'll close #4020..

@varodrig
Copy link
Contributor Author

/assign @vikas-saxena02

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
5 participants