Skip to content

Remove SECURITY.md#758

Merged
neilvcarvalho merged 1 commit into
mainfrom
nc-security-md-makes-no-sense-here
May 9, 2025
Merged

Remove SECURITY.md#758
neilvcarvalho merged 1 commit into
mainfrom
nc-security-md-makes-no-sense-here

Conversation

@neilvcarvalho
Copy link
Copy Markdown
Member

Our open source projects include a SECURITY.md file with instructions about supported versions and how to report a vulnerability. While this is an open source project, it's not a runnable app, but a collection of documents.

Recently, as a Markdown linting workflow was added to this project, it started competing with another workflow that keeps SECURITY.md up-to-date on how this file should be formatted.

This commit removes both SECURITY.md and the update-security GitHub Actions workflow.

Our open source projects include a SECURITY.md file with instructions
about supported versions and how to report a vulnerability. While this
is an open source project, it's not a runnable app, but a collection of
documents.

Recently, as a Markdown linting workflow was added to this project, it
started competing with another workflow that keeps SECURITY.md
up-to-date on how this file should be formatted.

This commit removes both SECURITY.md and the `update-security` GitHub
Actions workflow.
@cpytel cpytel self-requested a review May 9, 2025 17:06
Copy link
Copy Markdown
Contributor

@vburzynski vburzynski left a comment

Choose a reason for hiding this comment

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

Makes sense to remove this from the guides repo 👍
There may still be value in removing the extraneous lines in the templates to avoid re-encountering this issue in the future should one of the other repositories choose to add markdown linting.

@neilvcarvalho neilvcarvalho merged commit be9343c into main May 9, 2025
2 checks passed
@neilvcarvalho neilvcarvalho deleted the nc-security-md-makes-no-sense-here branch May 9, 2025 18:36
@neilvcarvalho
Copy link
Copy Markdown
Member Author

For some reason, I had SECURITY.md in mind, but the template changes are currently affecting README.md instead. Anyway, I still think it made sense here.

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.

3 participants