Skip to content

chore: fill or remove RSR template placeholders - #550

Merged
hyperpolymath merged 2 commits into
mainfrom
fix/rsr-placeholders
Jul 28, 2026
Merged

chore: fill or remove RSR template placeholders#550
hyperpolymath merged 2 commits into
mainfrom
fix/rsr-placeholders

Conversation

@hyperpolymath

Copy link
Copy Markdown
Owner

openssf-compliance.yml fails when any of the thirteen files it checks still contains a {{PLACEHOLDER}} token. This clears them.

Three kinds of change, no invention:

The "TEMPLATE INSTRUCTIONS (delete this block before publishing)" comment is deleted. The template says to delete it, and it is where every legend line lives -- so a large share of the reported tokens were the file documenting its own placeholders, not real unfilled fields.

Tokens derivable from the repository are filled: owner and repo from the git remote, project name, year, forge, main branch, contact email.

PGP and website lines are removed rather than filled, because nothing true could go in them. https://github.com/.gpg returns HTTP 200 for every account; with no key uploaded the body is a stub reading "This user hasnt uploaded any GPG keys". No key is published for either account here, and commit signing in this estate is SSH, which is unrelated. Only one repository in the estate has a domain, so {{WEBSITE}} likewise has no correct value. The template sanctions this: "Optional: Remove sections that dont apply (e.g. PGP if you dont use it)." A security policy telling a researcher to encrypt to a key that does not exist is worse than one that does not mention encryption.

Summary

Closes #

Type of change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (would change existing behaviour)
  • 🕳️ Soundness fix (fixes a checker/proof false-negative)
  • 📖 Documentation
  • 🧹 Refactor / tech debt (behaviour-preserving)
  • ⚡ Performance
  • 🔧 Build / CI / tooling

How has this been verified?

Checklist

  • My commits are signed (git commit -S).
  • I ran the project's own checks/tests locally and they pass.
  • New files carry the correct SPDX-License-Identifier (code/config MPL-2.0,
    prose CC-BY-SA-4.0); I did not relicense existing files.
  • Docs are updated, and no public claim now overstates what the code does.
  • I have not introduced a soundness hole (or I have flagged where I might have).

Notes for reviewers

hyperpolymath and others added 2 commits July 28, 2026 06:24
openssf-compliance.yml fails when any of the thirteen files it checks
still contains a {{PLACEHOLDER}} token. This clears them.

Three kinds of change, no invention:

The "TEMPLATE INSTRUCTIONS (delete this block before publishing)" comment
is deleted. The template says to delete it, and it is where every legend
line lives -- so a large share of the reported tokens were the file
documenting its own placeholders, not real unfilled fields.

Tokens derivable from the repository are filled: owner and repo from the
git remote, project name, year, forge, main branch, contact email.

PGP and website lines are removed rather than filled, because nothing
true could go in them. https://github.com/<user>.gpg returns HTTP 200 for
every account; with no key uploaded the body is a stub reading "This user
hasnt uploaded any GPG keys". No key is published for either account
here, and commit signing in this estate is SSH, which is unrelated. Only
one repository in the estate has a domain, so {{WEBSITE}} likewise has no
correct value. The template sanctions this: "Optional: Remove sections
that dont apply (e.g. PGP if you dont use it)." A security policy telling
a researcher to encrypt to a key that does not exist is worse than one
that does not mention encryption.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Signed-off-by: Jonathan D.A. Jewell <6759885+hyperpolymath@users.noreply.github.com>
@hyperpolymath
hyperpolymath merged commit d683766 into main Jul 28, 2026
19 of 20 checks passed
@hyperpolymath
hyperpolymath deleted the fix/rsr-placeholders branch July 28, 2026 07:08
@sonarqubecloud

Copy link
Copy Markdown

@gitar-bot

gitar-bot Bot commented Jul 28, 2026

Copy link
Copy Markdown
Code Review 👍 Approved with suggestions 0 resolved / 1 findings

Fills and removes RSR template placeholders to satisfy the openssf-compliance check. Consider removing the leftover PGP fingerprint row to align with the PR's rationale for dropping unconfigured PGP keys.

Auto-approved and auto-merge armed: No blocking issues found.
Please see Auto-approve Docs for details on setting custom approval criteria. — merges when pipeline and required approvals pass.

💡 Quality: Leftover PGP fingerprint row contradicts PR's remove-PGP rationale

📄 SECURITY.md:37-44

The PR's stated goal is to remove PGP references because no key exists, but SECURITY.md:37-44 still keeps the "Alternative: Encrypted Email" section header and a **Fingerprint** | [PGP fingerprint not set]`` row while removing the key link and gpg commands. This leaves a broken/misleading instruction — a researcher is told encryption is an alternative yet given no key and a stub fingerprint. Either drop the Fingerprint row (and rename the section to plain "Email"), or keep PGP wholesale. Note this [...] text is not a `{{PLACEHOLDER}}` token, so it won't fail the openssf-compliance check, but it is inconsistent with the change's intent.

🤖 Prompt for agents
Code Review: Fills and removes RSR template placeholders to satisfy the openssf-compliance check. Consider removing the leftover PGP fingerprint row to align with the PR's rationale for dropping unconfigured PGP keys.

1. 💡 Quality: Leftover PGP fingerprint row contradicts PR's remove-PGP rationale
   Files: SECURITY.md:37-44

   The PR's stated goal is to remove PGP references because no key exists, but SECURITY.md:37-44 still keeps the "Alternative: Encrypted Email" section header and a `**Fingerprint** | `[PGP fingerprint not set]`` row while removing the key link and gpg commands. This leaves a broken/misleading instruction — a researcher is told encryption is an alternative yet given no key and a stub fingerprint. Either drop the Fingerprint row (and rename the section to plain "Email"), or keep PGP wholesale. Note this `[...]` text is not a `{{PLACEHOLDER}}` token, so it won't fail the openssf-compliance check, but it is inconsistent with the change's intent.

Options

Auto-apply is off → Gitar will not commit updates to this branch.
Display: compact → Showing less information.

Comment with these commands to change the behavior for this request:

Auto-apply Compact
gitar auto-apply:on         
gitar display:verbose         

Was this helpful? React with 👍 / 👎 | Gitar

@gitar-bot gitar-bot 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.

Gitar has auto-approved this PR and enabled auto-merge (configure)

@gitar-bot gitar-bot Bot added the gitar-approved Added by Gitar label Jul 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gitar-approved Added by Gitar

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant