ts-patch-mongoose

Projects that follow the best practices below can voluntarily self-certify and show that they've achieved an Open Source Security Foundation (OpenSSF) best practices badge.

There is no set of practices that can guarantee that software will never have defects or vulnerabilities; even formal methods can fail if the specifications or assumptions are wrong. Nor is there any set of practices that can guarantee that a project will sustain a healthy and well-functioning development community. However, following best practices can help improve the results of projects. For example, some practices enable multi-person review before release, which can both help find otherwise hard-to-find technical vulnerabilities and help build trust and a desire for repeated interaction among developers from different companies. To earn a badge, all MUST and MUST NOT criteria must be met, all SHOULD criteria must be met OR be unmet with justification, and all SUGGESTED criteria must be met OR unmet (we want them considered at least). If you want to enter justification text as a generic comment, instead of being a rationale that the situation is acceptable, start the text block with '//' followed by a space. Feedback is welcome via the GitHub site as issues or pull requests There is also a mailing list for general discussion.

We gladly provide the information in several locales, however, if there is any conflict or inconsistency between the translations, the English version is the authoritative version.
If this is your project, please show your baseline badge status on your project page! The baseline badge status looks like this: Baseline badge level for project 12473 is baseline-1 Here is how to embed the baseline badge:
You can show your baseline badge status by embedding this in your markdown file:
[![OpenSSF Baseline](https://www.bestpractices.dev/projects/12473/baseline)](https://www.bestpractices.dev/projects/12473)
or by embedding this in your HTML:
<a href="https://www.bestpractices.dev/projects/12473"><img src="https://www.bestpractices.dev/projects/12473/baseline"></a>


These are the Baseline Level 3 criteria. These criteria are from baseline version v2025.10.10 with updated criteria text from version v2026.02.19. Criteria that are new in version v2026.02.19 are labeled "future" and will begin to be enforced starting 2026-06-01. Please provide answers to the "future" criteria before that date.

Baseline Series: Baseline Level 1 Baseline Level 2 Baseline Level 3

        

 Basics

  • General

    Note that other projects may use the same name.

    Patch history & events plugin for mongoose

    Please use SPDX license expression format; examples include "Apache-2.0", "BSD-2-Clause", "BSD-3-Clause", "GPL-2.0+", "LGPL-3.0+", "MIT", and "(BSD-2-Clause OR Ruby)". Do not include single quotes or double quotes.
    If there is more than one language, list them as comma-separated values (spaces optional) and sort them from most to least used. If there is a long list, please list at least the first three most common ones. If there is no language (e.g., this is a documentation-only or test-only project), use the single character "-". Please use a conventional capitalization for each language, e.g., "JavaScript".
    The Common Platform Enumeration (CPE) is a structured naming scheme for information technology systems, software, and packages. It is used in a number of systems and databases when reporting vulnerabilities.

 Controls 12/21 ●

  • Controls


    Enough for a badge!

    When a job is assigned permissions in a CI/CD pipeline, the source code or configuration MUST only assign the minimum privileges necessary for the corresponding activity. [OSPS-AC-04.02]
    Configure the project's CI/CD pipelines to assign the lowest available permissions to users and services by default, elevating permissions only when necessary for specific tasks. In some version control systems, this may be possible at the organizational or repository level. If not, set permissions at the top level of the pipeline.

    Each CI/CD job declares only the permissions it needs: pr-check uses contents: read; publish/provenance jobs use id-token: write and contents: write only where required for OIDC and release uploads; changelog uses contents: write only for the commit step: https://github.com/ilovepixelart/ts-patch-mongoose/blob/main/.github/workflows/publish.yaml


    Enough for a badge!

    (Future criterion) CI/CD pipelines which accept trusted collaborator input MUST sanitize and validate that input prior to use in the pipeline. [OSPS-BR-01.04]
    CI/CD pipelines should sanitize (quote, escape or exit on expected values) all collaborator inputs on explicit workflow executions. While collaborators are generally trusted, manual inputs to a workflow cannot be reviewed and could be abused by an account takeover or insider threat.

    The workflow_dispatch trigger in changelog.yaml accepts no custom inputs — it triggers with no user-supplied parameters. The publish workflow is triggered only by GitHub release events (not manual dispatch), so there are no trusted collaborator inputs to sanitize: https://github.com/ilovepixelart/ts-patch-mongoose/blob/main/.github/workflows/changelog.yaml


    Enough for a badge!

    When an official release is created, all assets within that release MUST be clearly associated with the release identifier or another unique identifier for the asset. [OSPS-BR-02.02]
    Assign a unique version identifier to each software asset produced by the project, following a consistent naming convention or numbering scheme. Examples include SemVer, CalVer, or git commit id.

    Each of the 70 releases has a unique version number (npm semver). Latest: v3.1.2 [version_unique]


    Enough for a badge!

    The project MUST define a policy for managing secrets and credentials used by the project. The policy should include guidelines for storing, accessing, and rotating secrets and credentials. [OSPS-BR-07.02]
    Document how secrets and credentials are managed and used within the project. This should include details on how secrets are stored (e.g., using a secrets management tool), how access is controlled, and how secrets are rotated or updated. Ensure that sensitive information is not hard-coded in the source code or stored in version control systems.

    SECURITY.md documents the secrets policy: all secrets (SONAR_TOKEN, GITHUB_TOKEN) are stored in GitHub Actions encrypted secrets, no credentials are hardcoded, and releases use OIDC keyless signing via Sigstore rather than long-lived signing keys. Dependabot keeps action dependencies up to date: https://github.com/ilovepixelart/ts-patch-mongoose/blob/main/SECURITY.md


    Not enough for a badge.

    When the project has made a release, the project documentation MUST contain instructions to verify the integrity and authenticity of the release assets. [OSPS-DO-03.01]
    Instructions in the project should contain information about the technology used, the commands to run, and the expected output. When possible, avoid storing this documentation in the same location as the build and release pipeline to avoid a single breach compromising both the software and the documentation for verifying the integrity of the software.

    // The project publishes npm provenance attestations and SLSA .intoto.jsonl files with each release, but the documentation does not yet include step-by-step instructions for how users can verify the integrity of release assets (e.g., using npm audit signatures or slsa-verifier commands).


    Not enough for a badge.

    When the project has made a release, the project documentation MUST contain instructions to verify the expected identity of the person or process authoring the software release. [OSPS-DO-03.02]
    The expected identity may be in the form of key IDs used to sign, issuer and identity from a sigstore certificate, or other similar forms. When possible, avoid storing this documentation in the same location as the build and release pipeline to avoid a single breach compromising both the software and the documentation for verifying the integrity of the software.

    // The project uses Sigstore keyless signing (OIDC-based) for provenance attestations, but the README/SECURITY.md do not yet include explicit instructions for verifying the expected issuer identity (e.g., the GitHub Actions OIDC issuer URL and workflow path to verify against).


    Enough for a badge!

    When the project has made a release, the project documentation MUST include a descriptive statement about the scope and duration of support for each release. [OSPS-DO-04.01]
    In order to communicate the scope and duration of support for the project's released software assets, the project should have a SUPPORT.md file, a "Support" section in SECURITY.md, or other documentation explaining the support lifecycle, including the expected duration of support for each release, the types of support provided (e.g., bug fixes, security updates), and any relevant policies or procedures for obtaining support.

    SECURITY.md includes a "Supported Versions" table documenting that only the latest 3.x release line receives security fixes, and older versions (1.x, 2.x) are end-of-life. This describes the scope and duration of support: https://github.com/ilovepixelart/ts-patch-mongoose/blob/main/SECURITY.md


    Enough for a badge!

    When the project has made a release, the project documentation MUST provide a descriptive statement when releases or versions will no longer receive security updates. [OSPS-DO-05.01]
    In order to communicate the scope and duration of support for security fixes, the project should have a SUPPORT.md or other documentation explaining the project's policy for security updates.

    SECURITY.md explicitly states: "Security fixes are issued only for the latest 3.x release line. Older major versions (1.x, 2.x) are no longer maintained — upgrade to 3.x if you need a security fix.": https://github.com/ilovepixelart/ts-patch-mongoose/blob/main/SECURITY.md


    Not enough for a badge.

    While active, the project documentation MUST have a policy that code collaborators are reviewed prior to granting escalated permissions to sensitive resources. [OSPS-GV-04.01]
    Publish an enforceable policy in the project documentation that requires code collaborators to be reviewed and approved before being granted escalated permissions to sensitive resources, such as merge approval or access to secrets. It is recommended that vetting includes establishing a justifiable lineage of identity such as confirming the contributor's association with a known trusted organization.

    // This is a single-maintainer personal project. There is no formal policy document for reviewing collaborators before granting escalated permissions, as there are currently no collaborators with elevated access beyond the owner.


    Not enough for a badge.

    When the project has made a release, all compiled released software assets MUST be delivered with a software bill of materials. [OSPS-QA-02.02]
    It is recommended to auto-generate SBOMs at build time using a tool that has been vetted for accuracy. This enables users to ingest this data in a standardized approach alongside other projects in their environment.

    // The publish pipeline produces npm provenance attestations and SLSA provenance files, but does not currently generate a Software Bill of Materials (SBOM) in a standard format (e.g., SPDX or CycloneDX) alongside the release assets.


    Enough for a badge!

    When the project has made a release comprising multiple source code repositories, all subprojects MUST enforce security requirements that are as strict or stricter than the primary codebase. [OSPS-QA-04.02]
    Any additional subproject code repositories produced by the project and compiled into a release must enforce security requirements as applicable to the status and intent of the respective codebase. In addition to following the corresponding OSPS Baseline requirements, this may include requiring a security review, ensuring that it is free of vulnerabilities, and ensuring that it is free of known security issues.

    This project consists of a single repository with no additional subproject repositories, so this criterion does not apply.


    Enough for a badge!

    While active, project's documentation MUST clearly document when and how tests are run. [OSPS-QA-06.02]
    Add a section to the contributing documentation that explains how to run the tests locally and how to run the tests in the CI/CD pipeline. The documentation should explain what the tests are testing and how to interpret the results.

    Uses vitest with full coverage reporting. Tests are in the 'tests' directory: https://github.com/ilovepixelart/ts-patch-mongoose/tree/main/tests [test]


    Enough for a badge!

    While active, the project's documentation MUST include a policy that all major changes to the software produced by the project should add or update tests of the functionality in an automated test suite. [OSPS-QA-06.03]
    Add a section to the contributing documentation that explains the policy for adding or updating tests. The policy should explain what constitutes a major change and what tests should be added or updated.

    The test policy is documented in CONTRIBUTING.md which states tests must be written for new features: https://github.com/ilovepixelart/ts-patch-mongoose/blob/main/CONTRIBUTING.md [tests_documented_added]


    Not enough for a badge.

    When a commit is made to the primary branch, the project's version control system MUST require at least one non-author human approval of the changes before merging. [OSPS-QA-07.01]
    Configure the project's version control system to require at least one non-author human approval of changes before merging into the release or primary branch. This can be achieved by requiring a pull request to be reviewed and approved by at least one other collaborator before it can be merged.

    // This is a single-maintainer personal project. The SECURITY.md acknowledges that Scorecard flags the absence of multi-person review, noting that requiring approvals would block all work or force fake approvals for a single maintainer.


    Enough for a badge!

    When the project has made a release, the project MUST perform a threat modeling and attack surface analysis to understand and protect against attacks on critical code paths, functions, and interactions within the system. [OSPS-SA-03.02]
    Threat modeling is an activity where the project looks at the codebase, associated processes and infrastructure, interfaces, key components and "thinks like a hacker" and brainstorms how the system be be broken or compromised. Each identified threat is listed out so the project can then think about how to proactively avoid or close off any gaps/vulnerabilities that could arise. Ensure this is updated for new features or breaking changes.

    SECURITY.md contains a detailed threat model and attack surface analysis covering: in-scope components (plugin source and npm tarball), out-of-scope items, supply chain analysis (zero runtime deps, provenance attestations), and the OpenSSF Scorecard analysis with rationale for accepted risks: https://github.com/ilovepixelart/ts-patch-mongoose/blob/main/SECURITY.md


    Not enough for a badge.

    While active, any vulnerabilities in the software components not affecting the project MUST be accounted for in a VEX document, augmenting the vulnerability report with non-exploitability details. [OSPS-VM-04.02]
    Establish a VEX feed communicating the exploitability status of known vulnerabilities, including assessment details or any mitigations in place preventing vulnerable code from being executed.

    // The project does not currently publish a VEX (Vulnerability Exploitability eXchange) document or feed to communicate non-exploitability status for known CVEs in dependencies. The project has zero runtime dependencies which limits exposure, but no formal VEX feed is maintained.


    Not enough for a badge.

    While active, the project documentation MUST include a policy that defines a threshold for remediation of SCA findings related to vulnerabilities and licenses. [OSPS-VM-05.01]
    Document a policy in the project that defines a threshold for remediation of SCA findings related to vulnerabilities and licenses. Include the process for identifying, prioritizing, and remediating these findings.

    // The project uses Dependabot for GitHub Actions updates and runs npm audit signatures in CI, but there is no formally documented policy defining a threshold (e.g., severity level) for remediation of SCA findings related to vulnerabilities or license compliance.


    Not enough for a badge.

    While active, the project documentation MUST include a policy to address SCA violations prior to any release. [OSPS-VM-05.02]
    Document a policy in the project to address applicable Software Composition Analysis results before any release, and add status checks that verify compliance with that policy prior to release.

    // There is no automated SCA check configured as a required status check that must pass before releases. Dependabot monitors action dependencies but there is no npm audit or equivalent SCA gate enforced in the release pipeline.


    Not enough for a badge.

    While active, all changes to the project's codebase MUST be automatically evaluated against a documented policy for malicious dependencies and known vulnerabilities in dependencies, then blocked in the event of violations, except when declared and suppressed as non-exploitable. [OSPS-VM-05.03]
    Create a status check in the project's version control system that runs a Software Composition Analysis tool on all changes to the codebase. Require that the status check passes before changes can be merged.

    // Dependabot monitors GitHub Actions dependencies weekly, but there is no automated SCA status check (e.g., npm audit, Snyk, or Socket.dev) configured as a required blocking check on pull requests for npm dependency vulnerabilities.


    Enough for a badge!

    While active, the project documentation MUST include a policy that defines a threshold for remediation of SAST findings. [OSPS-VM-06.01]
    Document a policy in the project that defines a threshold for remediation of Static Application Security Testing (SAST) findings. Include the process for identifying, prioritizing, and remediating these findings.

    CI (pr-check.yaml) runs Biome and TypeScript checks on every PR and these must pass. Issues are fixed before merging. [static_analysis_fixed]


    Enough for a badge!

    While active, all changes to the project's codebase MUST be automatically evaluated against a documented policy for security weaknesses and blocked in the event of violations except when declared and suppressed as non-exploitable. [OSPS-VM-06.02]
    Create a status check in the project's version control system that runs a Static Application Security Testing (SAST) tool on all changes to the codebase. Require that the status check passes before changes can be merged.

    Biome (static analyzer/linter) and TypeScript type checker run in CI on every PR: https://github.com/ilovepixelart/ts-patch-mongoose/blob/main/.github/workflows/pr-check.yaml [static_analysis]



This data is available under the Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). This means that a Data Recipient may share the Data, with or without modifications, so long as the Data Recipient makes available the text of this agreement with the shared Data. Please credit Alex and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Alex.
Entry created on 2026-04-12 13:40:29 UTC, last updated on 2026-04-12 14:09:34 UTC. Last achieved passing badge on 2026-04-12 13:51:17 UTC.