chore: add SECURITY.md with vulnerability reporting guidelines and supported versions - #4059
Conversation
|
Thanks for opening a Pull Request. If you want to perform a review write a comment saying: @ansys-reviewer-bot review |
Reviewer's GuideThis PR adds a new SECURITY.md file outlining vulnerability reporting guidelines, supported versions, and license information. File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey @germa89 - I've reviewed your changes - here's some feedback:
- Consider removing the MIT license header from SECURITY.md to avoid duplicating the repo license and keep the security policy focused.
- Add an expected timeline for vulnerability triage and resolution (e.g. initial response within X days) to set clear expectations for reporters.
- Replace GitHub emoji syntax in the version support table with plain Unicode checkmarks and crosses to ensure consistent rendering across Markdown viewers.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider removing the MIT license header from SECURITY.md to avoid duplicating the repo license and keep the security policy focused.
- Add an expected timeline for vulnerability triage and resolution (e.g. initial response within X days) to set clear expectations for reporters.
- Replace GitHub emoji syntax in the version support table with plain Unicode checkmarks and crosses to ensure consistent rendering across Markdown viewers.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
Following #4054 and blatantly copying the security file from PyAnsys Geometry - Security file; I have set the supported versions to the last 3. But thinking about it, I dont think it makes much sense, like... we are in 0.70.2 in PyMAPDL. If a bug is fixed, it is published in 0.70.3. We do not keep branches with 0.69.X or 0.68.X. Hence, the list of supported versions is only 0.70.3. Am I right? Pinging @ansys/pyansys-core for review and feedback on the comment above. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4059 +/- ##
==========================================
- Coverage 89.18% 89.14% -0.05%
==========================================
Files 187 187
Lines 14993 14993
==========================================
- Hits 13372 13365 -7
- Misses 1621 1628 +7 🚀 New features to boost your workflow:
|
Well - I think it is a good practice to support users that might be stuck with older versions in terms of security issues. Imagine you find a bad security vulnerability (not a normal patch, or feature). You should support a few minor releases in that sense I believe. But at the end of the day, it's the maintainers decision =) |
|
In theory, we could do that. In practice we dont. But yeah, nothing is preventing us to cherry pick bugs to older branches. Ok. Great. Thank you for your feedback @RobPasMue |
|
@pyansys-ci-bot LGTM. |

Description
Add security file with policies and supported versions to the repo.
Issue linked
Close #4054
Checklist
draftif it is not ready to be reviewed yet.feat: adding new MAPDL command)Summary by Sourcery
Add SECURITY.md to define the project's security policy, including supported versions and instructions for reporting vulnerabilities.
Documentation: