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

Add error or warning for GitHub links #828

Closed
apinnick opened this issue Jul 10, 2024 · 5 comments · Fixed by #843
Closed

Add error or warning for GitHub links #828

apinnick opened this issue Jul 10, 2024 · 5 comments · Fixed by #843
Assignees

Comments

@apinnick
Copy link
Collaborator

OpenShift does not allow links to GitHub repositories unless they are in auto-generated API references. Other projects require project management approval. The RHSSG also does not allow links to GitHub. I think it would be a good idea to add a rule to detect GitHub links.

@aireilly
Copy link
Member

aireilly commented Jul 24, 2024

Great idea! Do you want to put this in? Something like this would work:

---
extends: substitution
ignorecase: false
level: error
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/github/
message: "%s"
scope: raw
swap:
  # Start each error message with "Do not use ..."
  # Error messages must be single quoted.
  'https://github.com/': 'Do not include links to GitHub in source.'

@apinnick
Copy link
Collaborator Author

Feel free to assign me to this issue if that helps.

apinnick added a commit to apinnick/vale-at-red-hat that referenced this issue Jul 25, 2024
apinnick added a commit to apinnick/vale-at-red-hat that referenced this issue Jul 25, 2024
apinnick added a commit to apinnick/vale-at-red-hat that referenced this issue Jul 25, 2024
apinnick added a commit to apinnick/vale-at-red-hat that referenced this issue Jul 25, 2024
apinnick added a commit to apinnick/vale-at-red-hat that referenced this issue Jul 25, 2024
@aireilly
Copy link
Member

Note - repos inside the OpenShift org are Ok. https://github.com/openshift/* are fine.

@apinnick
Copy link
Collaborator Author

apinnick commented Jul 25, 2024

Note - repos inside the OpenShift org are Ok. https://github.com/openshift/* are fine.

I think "owned and maintained by Red Hat" would cover that. Or did you want that URL in the 'valid' list?

apinnick added a commit to apinnick/vale-at-red-hat that referenced this issue Jul 25, 2024
apinnick added a commit to apinnick/vale-at-red-hat that referenced this issue Jul 25, 2024
@aireilly
Copy link
Member

I think we need clarification from @kalexand-rh maybe. Are all GitHub links forbidden? Or are GitHub links from inside the OpenShift organization allowed?

apinnick added a commit to apinnick/vale-at-red-hat that referenced this issue Jul 31, 2024
apinnick added a commit to apinnick/vale-at-red-hat that referenced this issue Aug 27, 2024
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 a pull request may close this issue.

2 participants