Skip to content

docs: make the security policy org-wide - #48

Merged
uniqueg merged 1 commit into
mainfrom
docs/security-org-wide
Nov 1, 2026
Merged

uniqueg merged 1 commit into
mainfrom
docs/security-org-wide

Conversation

@uniqueg

@uniqueg uniqueg commented Nov 1, 2026 •

Copy link
Copy Markdown
Member

Summary

Makes SECURITY.md the security policy of every repository of the
organisation, so that foca-plugins' own SECURITY.md can go (#38), by adding
generic forms of its additions:

  • reports name the affected repository and package(s) with their versions,
    the versions of the components they run with (e.g., the FOCA version of an
    app) and the relevant configuration (without secrets);
  • in repositories that publish several packages, fixes are released for each
    affected package, and for any package that pins it;
  • vulnerabilities go to the repository of the component that has them (e.g.,
    FOCA for the framework); if unsure, report where you found it, and the
    maintainers route it;
  • replaces "repositories with their own policy follow that one" with:
    repositories don't have their own SECURITY.md;
  • replaces "ELIXIR Cloud & AAI" with "ELIXIR On-Cloud".

Closes #40

Light lane: documentation text only (no code, workflows or configuration),
so no reviewer subagents; I reviewed the diff myself.

Verification

  • pre-commit run --all-files and
    pre-commit run --all-files --hook-stage manual gitleaks-all: all hooks
    passed (markdownlint included).
  • CI: passed (Lint, Test, CI passed, CodeQL); Sourcery check passed.

Declined review findings

  • Sourcery: "repository reporters see old guidance" (repositories with their
    own SECURITY.md still override this one). Intended: removing
    foca-plugins' SECURITY.md is foca-plugins#35, which this issue blocks.

Open questions

None.

🤖 Generated with Claude Code

Add generic forms of the additions of foca-plugins' SECURITY.md to the
org security policy: reports name the affected packages, the versions
of the components they run with and the configuration; repositories
that publish several packages release fixes for each affected package
and any package that pins it; vulnerabilities go to the repository of
the component that has them. State that repositories have no
SECURITY.md of their own, and replace the deprecated name "ELIXIR
Cloud & AAI" with "ELIXIR On-Cloud".

Closes #40

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@sourcery-ai

sourcery-ai Bot commented Nov 1, 2026 •

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates SECURITY.md to serve as the organisation-wide ELIXIR On-Cloud security policy, clarifying report routing, required vulnerability context, and package-level remediation expectations.

File-Level Changes

Change Details Files
Make the repository security policy applicable across the entire ELIXIR On-Cloud organisation.
  • Replace the former conditional policy scope with an organisation-wide statement.
  • Clarify that repositories do not maintain separate SECURITY.md policies.
  • Update the organisation name and link terminology.
SECURITY.md
Clarify vulnerability reporting ownership and the information reporters should provide.
  • Direct reports to the repository owning the vulnerable component, with fallback routing guidance.
  • Require affected packages and versions, runtime component versions, and relevant non-secret configuration.
SECURITY.md
Define remediation expectations for repositories publishing multiple packages.
  • Require fixes for each affected package and packages that pin it while retaining latest-release support guidance.
SECURITY.md

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

@uniqueg
uniqueg marked this pull request as ready for review November 1, 2026 03:28

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey - I've found 1 issue

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="SECURITY.md" line_range="4-5" />
<code_context>
 This policy applies to every repository of
-[ELIXIR Cloud & AAI](https://github.com/elixir-cloud-aai) that has no
-`SECURITY.md` of its own; repositories with their own policy follow that one.
+[ELIXIR On-Cloud](https://github.com/elixir-cloud-aai); repositories don't
+have their own `SECURITY.md`.

 ## Reporting a vulnerability
</code_context>
<issue_to_address>
**Repository reporters see old guidance**

When an organization repository retains its own `SECURITY.md`, including foca-plugins, gitHub serves that repository’s `SECURITY.md` instead of this organization default, so its reporters see different guidance and this policy does not apply to them.

Remove or update repository-local `SECURITY.md` files so reporters receive the intended policy.
</issue_to_address>

Linked issues

#40 docs: make the security policy org-wide · 5 of 5 met

# Requirement Status Notes
1 Reports name the affected repository and package(s), their versions, component versions, and relevant configuration without secrets. ✅ Met The reporting checklist asks for the affected repository and package versions, component versions, and relevant configuration without secrets.
2 For repositories publishing several packages, release fixes for each affected package and any package that pins it. ✅ Met The supported-versions section includes this guidance.
3 Report vulnerabilities to the repository of the affected component; if unsure, report where found so maintainers can route it. ✅ Met The reporting section gives this direction and the FOCA example.
4 Replace the statement that repositories with their own policy follow that policy with a statement that repositories do not have their own SECURITY.md. ✅ Met The opening now states that repositories don't have their own SECURITY.md.
5 Replace “ELIXIR Cloud & AAI” with “ELIXIR On-Cloud”. ✅ Met The policy names ELIXIR On-Cloud.

Sourcery assessment

Approval pending. 1 finding to address first.

Blocking findings: SECURITY.md:5


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

Comment thread SECURITY.md Resolved
@uniqueg
uniqueg merged commit 58a2bed into main Nov 1, 2026
6 checks passed
@uniqueg
uniqueg deleted the docs/security-org-wide branch November 1, 2026 03:34
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.

docs: make the security policy org-wide

1 participant