Skip to content

chore: add SECURITY.md with vulnerability reporting guidelines and supported versions - #4059

Merged
germa89 merged 3 commits into
mainfrom
maint/adding-security-file
Jul 1, 2025
Merged

chore: add SECURITY.md with vulnerability reporting guidelines and supported versions#4059
germa89 merged 3 commits into
mainfrom
maint/adding-security-file

Conversation

@germa89

@germa89 germa89 commented Jun 30, 2025

Copy link
Copy Markdown
Collaborator

Description

Add security file with policies and supported versions to the repo.

Issue linked

Close #4054

Checklist

Summary by Sourcery

Add SECURITY.md to define the project's security policy, including supported versions and instructions for reporting vulnerabilities.

Documentation:

  • Add a SECURITY.md file outlining supported project versions and compatibility.
  • Document the proper process and required details for securely reporting vulnerabilities.

@germa89
germa89 requested a review from a team as a code owner June 30, 2025 11:30
@ansys-reviewer-bot

Copy link
Copy Markdown
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

@germa89 germa89 self-assigned this Jun 30, 2025
@sourcery-ai

sourcery-ai Bot commented Jun 30, 2025

Copy link
Copy Markdown
Contributor

Reviewer's Guide

This PR adds a new SECURITY.md file outlining vulnerability reporting guidelines, supported versions, and license information.

File-Level Changes

Change Details Files
Introduce security guidelines document
  • Add MIT license header
  • Define supported versions table
  • Detail vulnerability reporting process and required information
  • Link to MAPDL compatibility documentation
SECURITY.md

Assessment against linked issues

Issue Objective Addressed Explanation
#4054 Add a SECURITY.md file to the repository.
#4054 Ensure the SECURITY.md file is up-to-date with the expected format.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@github-actions github-actions Bot added the maintenance General maintenance of the repo (libraries, cicd, etc) label Jun 30, 2025
@github-actions github-actions Bot added maintenance General maintenance of the repo (libraries, cicd, etc) and removed maintenance General maintenance of the repo (libraries, cicd, etc) labels Jun 30, 2025
@germa89

germa89 commented Jun 30, 2025

Copy link
Copy Markdown
Collaborator Author

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.

@germa89 germa89 changed the title maint: add SECURITY.md with vulnerability reporting guidelines and supported versions chore: add SECURITY.md with vulnerability reporting guidelines and supported versions Jun 30, 2025
@github-actions github-actions Bot added enhancement Improve any current implemented feature and removed maintenance General maintenance of the repo (libraries, cicd, etc) labels Jun 30, 2025
@codecov

codecov Bot commented Jun 30, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.14%. Comparing base (ed77001) to head (1a20232).
Report is 4 commits behind head on main.

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:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@germa89
germa89 requested a review from a team July 1, 2025 07:16
@RobPasMue

Copy link
Copy Markdown
Member

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?

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 =)

@germa89

germa89 commented Jul 1, 2025

Copy link
Copy Markdown
Collaborator Author

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

@germa89

germa89 commented Jul 1, 2025

Copy link
Copy Markdown
Collaborator Author

@pyansys-ci-bot LGTM.

@germa89
germa89 enabled auto-merge (squash) July 1, 2025 09:26

@pyansys-ci-bot pyansys-ci-bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

✅ Approving this PR because germa89 said so in here 😬

LGTM

@germa89
germa89 merged commit eaf5df4 into main Jul 1, 2025
@germa89
germa89 deleted the maint/adding-security-file branch July 1, 2025 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement Improve any current implemented feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[MAINTENANCE] Missing or outdated SECURITY.md file in ansys/pymapdl

3 participants