flowpact

Los proyectos que siguen las mejores prácticas a continuación pueden autocertificarse voluntariamente y demostrar que han obtenido una insignia de mejores prácticas de Open Source Security Foundation (OpenSSF).

No existe un conjunto de prácticas que pueda garantizar que el software nunca tendrá defectos o vulnerabilidades; incluso los métodos formales pueden fallar si las especificaciones o suposiciones son incorrectas. Tampoco existe ningún conjunto de prácticas que pueda garantizar que un proyecto mantenga una comunidad de desarrollo saludable y que funcione bien. Sin embargo, seguir las mejores prácticas puede ayudar a mejorar los resultados de los proyectos. Por ejemplo, algunas prácticas permiten la revisión por parte de múltiples personas antes del lanzamiento, lo que puede ayudar a encontrar vulnerabilidades técnicas que de otro modo serían difíciles de encontrar y ayudar a generar confianza y un deseo repetido de interacción entre desarrolladores de diferentes compañías. Para obtener una insignia, se deben cumplir todos los criterios DEBE y NO DEBE, se deben cumplir, así como todos los criterios DEBERÍAN deben cumplirse o ser justificados, y todos los criterios SUGERIDOS se pueden cumplir o incumplir (queremos que se consideren al menos). Si desea añadir texto como justificación mediante un comentario genérico, en lugar de ser un razonamiento de que la situación es aceptable, comience el bloque de texto con '//' seguido de un espacio. Los comentarios son bienvenidos a través del sitio de GitHub mediante "issues" o "pull requests". También hay una lista de correo electrónico para el tema principal.

Con mucho gusto proporcionaríamos la información en varios idiomas, sin embargo, si hay algún conflicto o inconsistencia entre las traducciones, la versión en inglés es la versión autorizada.
Si este es su proyecto, por favor muestre el estado de su insignia base en la página de su proyecto. El estado de la insignia base se ve así: El nivel de insignia base para el proyecto 15403 es baseline-2 Aquí se explica cómo insertar la insignia base:
Puede mostrar el estado de su insignia base insertando esto en su archivo markdown:
[![OpenSSF Baseline](https://www.bestpractices.dev/projects/15403/baseline)](https://www.bestpractices.dev/projects/15403)
o insertando esto en su HTML:
<a href="https://www.bestpractices.dev/projects/15403"><img src="https://www.bestpractices.dev/projects/15403/baseline"></a>


Estos son los criterios de Nivel Base 2. Estos son los criterios de la versión v2026.08.28.

Baseline Series: Nivel Base 1 Nivel Base 2 Nivel Base 3

        

 Fundamentos

  • General

    Tenga en cuenta que otros proyectos pueden usar el mismo nombre.

    Data-flow linter for GitHub Actions: finds inputs, secrets and matrix values that arrive empty across reusable workflows, local actions and matrix combinations, and grades the release impact of changes. CLI, GitHub Action, VS Code extension.

    Por favor use formato de expresión de licencia SPDX; los ejemplos incluyen "Apache-2.0", "BSD-2-Clause", "BSD-3-Clause", "GPL-2.0+", "LGPL-3.0+", "MIT" y "(BSD-2-Clause OR Ruby)". No incluya comillas simples o comillas dobles.
    Si hay más de un lenguaje, enumérelos como valores separados por comas (los espacios son opcionales) y ordénelos de más a menos usado. Si hay una lista larga, por favor enumere al menos los tres primeros más comunes. Si no hay lenguaje (por ejemplo, este es un proyecto solo de documentación o solo de pruebas), use el carácter único "-". Por favor use una capitalización convencional para cada lenguaje, por ejemplo, "JavaScript".
    La Common Platform Enumeration (CPE) es un esquema de nomenclatura estructurado para sistemas de tecnología de la información, software y paquetes. Se utiliza en varios sistemas y bases de datos al reportar vulnerabilidades.

 Controles 19/19 ●

  • Controles


    ¡Suficiente para una insignia!

    Cuando una tarea de CI/CD se ejecuta sin permisos especificados, el sistema de CI/CD DEBE establecer por defecto los permisos de la tarea a los permisos más bajos otorgados en el pipeline. [OSPS-AC-04.01]
    Configure las configuraciones del proyecto para asignar los permisos más bajos disponibles a nuevos pipelines por defecto, otorgando permisos adicionales solo cuando sea necesario para tareas específicas.

    The GITHUB_TOKEN default is read-only, the lowest setting, for both the ciatlas organization and the repository, and workflows cannot approve pull requests, so a job that sets no permissions gets read access only. Every workflow also sets its own top-level permissions: contents: read in most, {} in pr-title.yml, read-all in scorecard.yml, and in docs.yml contents: read with pages: write and id-token: write for the Pages deployment. Other write scopes are granted only on the jobs that use them (https://github.com/ciatlas/flowpact/tree/main/.github/workflows).


    ¡Suficiente para una insignia!

    Cuando se crea un lanzamiento oficial, ese lanzamiento DEBE ser asignado un identificador de versión único. [OSPS-BR-02.01]
    Asigne un identificador de versión único a cada lanzamiento producido por el proyecto, siguiendo una convención de nomenclatura o esquema de numeración consistente. Los ejemplos incluyen SemVer, CalVer o ID de commit de git.

    Every release gets a unique Semantic Versioning number and a vX.Y.Z tag, which release-please computes from Conventional Commit titles (https://github.com/ciatlas/flowpact/blob/main/release-please-config.json, https://github.com/ciatlas/flowpact/blob/main/CHANGELOG.md). npm never accepts a version twice, releases are immutable since 0.10.0, and a ruleset lets only the release bot and admins create, move or delete v* tags.


    ¡Suficiente para una insignia!

    Cuando se crea un lanzamiento oficial, ese lanzamiento DEBE contener un registro descriptivo de modificaciones funcionales y de seguridad. [OSPS-BR-04.01]
    Asegúrese de que todos los lanzamientos incluyan un registro de cambios descriptivo. Se recomienda asegurar que el registro de cambios sea legible por humanos e incluya detalles más allá de los mensajes de commit, como descripciones del impacto de seguridad o relevancia para diferentes casos de uso. Para asegurar la legibilidad automática, coloque el contenido bajo un encabezado markdown como "## Changelog".

    Every release has a descriptive changelog, both on its GitHub release page (https://github.com/ciatlas/flowpact/releases) and in https://github.com/ciatlas/flowpact/blob/main/CHANGELOG.md. It groups changes into breaking changes with upgrade steps, features, bug fixes and performance, written from user-facing PR titles. Security-relevant changes are listed too, for example 0.9.0's 'harden 0.9.0 before its release: flag values, plugins, report paths and release assets' and 0.12.1's bounded walking of linked directories.


    ¡Suficiente para una insignia!

    Cuando un pipeline de construcción y lanzamiento ingiere dependencias, DEBE usar herramientas estandarizadas donde estén disponibles. [OSPS-BR-05.01]
    Use herramientas comunes para su ecosistema, como gestores de paquetes o herramientas de gestión de dependencias para ingerir dependencias en tiempo de construcción. Esto puede incluir usar un archivo de dependencias, archivo de bloqueo o manifiesto para especificar las dependencias requeridas, que luego son incorporadas por el sistema de construcción.

    The build and release pipelines take dependencies through pnpm, the project's standard package manager. The version is pinned in package.json's packageManager, and every CI and release job runs pnpm install --frozen-lockfile against the committed lockfile (https://github.com/ciatlas/flowpact/blob/main/.github/workflows/release.yml, https://github.com/ciatlas/flowpact/blob/main/.github/workflows/ci.yml). Workflow actions are pinned to commit SHAs and updated by Renovate.


    ¡Suficiente para una insignia!

    Cuando se crea un lanzamiento oficial, ese lanzamiento DEBE estar firmado o registrado en un manifiesto firmado que incluya los hashes criptográficos de cada activo. [OSPS-BR-06.01]
    Firme todos los activos de software lanzados en tiempo de construcción con una firma criptográfica o atestaciones, como firma GPG o PGP, firmas Sigstore, proveniencia SLSA, o VSAs SLSA. Incluya los hashes criptográficos de cada activo en un manifiesto firmado o archivo de metadatos.

    The npm tarball, the Action archive and the .vsix each have a Sigstore-signed SLSA build provenance attestation from GitHub Actions, attached as .sigstore.json and .intoto.jsonl, and each CycloneDX SBOM is attested against its artifact. Since 0.10.0 every release is also an immutable GitHub release whose signed release attestation lists the SHA-256 of every attached file (gh release verify), and the npm package has npm provenance. See https://github.com/ciatlas/flowpact/blob/main/SECURITY.md#verifying-releases and https://ciatlas.github.io/flowpact/docs/security/#verify-a-release.


    ¡Suficiente para una insignia!

    Cuando el proyecto ha realizado un lanzamiento, la documentación del proyecto DEBE incluir una descripción de cómo el proyecto selecciona, obtiene y rastrea sus dependencias. [OSPS-DO-06.01]
    Se recomienda publicar esta información junto con la documentación técnica y de diseño del proyecto en un recurso públicamente visible como el repositorio de código fuente, sitio web del proyecto u otro canal.

    https://github.com/ciatlas/flowpact/blob/main/CONTRIBUTING.md#dependencies describes how dependencies are selected (reviewed in a pull request, bundled into every artifact), obtained (pnpm with a frozen lockfile, a two-day minimum release age, install scripts only for allowlisted packages, @ciatlas/core from a release tag, actions pinned to commit SHAs) and tracked (Renovate, OSV vulnerability alerts, and an SBOM and license notices in every release).


    ¡Suficiente para una insignia!

    La documentación del proyecto DEBE incluir instrucciones sobre cómo compilar el software, incluyendo las bibliotecas, marcos, SDK y dependencias necesarias. [OSPS-DO-07.01]
    Se recomienda publicar esta información junto con la documentación para colaboradores del proyecto, por ejemplo en CONTRIBUTING.md u otra documentación de tareas para desarrolladores. También puede documentarse utilizando objetivos de Makefile u otros scripts de automatización.

    https://github.com/ciatlas/flowpact/blob/main/CONTRIBUTING.md#setup lists what a build needs: Node.js 22 or later, and pnpm, pinned in package.json and enabled with corepack enable. It also gives the commands. pnpm install fetches every dependency from the lockfile, including the workflow model @ciatlas/core from its GitHub release tag (explained in the next section). pnpm build bundles the CLI and the GitHub Action.


    ¡Suficiente para una insignia!

    La documentación del proyecto DEBE incluir una lista de los miembros del proyecto que tienen acceso a recursos sensibles. [OSPS-GV-01.01]
    Documente los participantes del proyecto y sus roles a través de artefactos tales como members.md, governance.md, maintainers.md, o archivo similar dentro del repositorio de código fuente del proyecto. Esto puede ser tan simple como incluir nombres o identificadores de cuenta en una lista de mantenedores, o más complejo dependiendo de la gobernanza del proyecto.

    https://github.com/ciatlas/flowpact/blob/main/MAINTAINERS.md#access-to-sensitive-resources lists everyone and everything with access to the project's sensitive resources: the GitHub organization and repositories, the two GitHub Apps and their permissions, the release bot's credentials, and the npm, VS Code Marketplace, Azure and Open VSX accounts that publish releases.


    ¡Suficiente para una insignia!

    La documentación del proyecto DEBE incluir descripciones de los roles y responsabilidades de los miembros del proyecto [OSPS-GV-01.02]
    Documente los participantes del proyecto y sus roles a través de artefactos tales como members.md, governance.md, maintainers.md, o archivo similar dentro del repositorio de código fuente del proyecto.

    https://github.com/ciatlas/flowpact/blob/main/MAINTAINERS.md#roles-and-responsibilities describes the roles (maintainer, contributors, the release bot, Renovate) and what each is responsible for, and how access is given and taken away when people join or leave.


    ¡Suficiente para una insignia!

    La documentación del proyecto DEBE incluir una guía para colaboradores de código que incluya los requisitos para que las contribuciones sean aceptables. [OSPS-GV-03.02]
    Extienda el CONTRIBUTING.md o los contenidos de CONTRIBUTING/ en la documentación del proyecto para delinear los requisitos para contribuciones aceptables, incluyendo estándares de codificación, requisitos de pruebas y pautas de envío para contribuidores de código. Se recomienda que esta guía sea la fuente de verdad tanto para contribuidores como para aprobadores.

    https://github.com/ciatlas/flowpact/blob/main/CONTRIBUTING.md#pull-requests sets the requirements for an acceptable contribution. They are a Conventional Commits PR title and the required CI checks: Biome lint, typecheck, tests on Node 22 and 24, line coverage of at least 80% overall and 90% in packages/lint, and fallow code health. A behaviour change needs tests, and a bug fix needs a test that fails without it. Docs and the committed action bundle must be regenerated, and a code owner must approve.


    ¡Suficiente para una insignia!

    El sistema de control de versiones DEBE requerir que todos los colaboradores de código afirmen que están legalmente autorizados para realizar las contribuciones asociadas en cada confirmación (commit). [OSPS-LE-01.01]
    Incluya un DCO en el repositorio del proyecto, requiriendo que los contribuidores de código afirmen que están legalmente autorizados para confirmar las contribuciones asociadas en cada commit. Use una verificación de estado para asegurar que se haga la afirmación. Un CLA también satisface este requisito. Algunos sistemas de control de versiones, como GitHub, pueden incluir esto en los términos de servicio de la plataforma.

    Every change reaches main through a pull request on GitHub (the main ruleset requires one and has no bypass, https://github.com/ciatlas/flowpact/blob/main/.github/rulesets/main.json). Under section D.6 of GitHub's Terms of Service, contributors to this MIT-licensed repository assert they have the right to license their contributions, as https://github.com/ciatlas/flowpact/blob/main/CONTRIBUTING.md#pull-requests also states.


    ¡Suficiente para una insignia!

    Cuando se realiza un commit a la rama principal, cualquier verificación de estado automatizada para commits DEBE pasar o ser omitida manualmente. [OSPS-QA-03.01]
    Configure el sistema de control de versiones del proyecto para requerir que todas las verificaciones de estado automatizadas pasen o requieran reconocimiento manual antes de que un commit pueda fusionarse en la rama principal. Se recomienda que cualquier verificación de estado opcional NO esté configurada como un requisito de pasar o fallar que los aprobadores puedan estar tentados a omitir.

    The live main ruleset has no bypass actors and requires the 'CI passed' and 'Conventional PR title' checks to pass on an up-to-date branch before any merge (https://github.com/ciatlas/flowpact/blob/main/.github/rulesets/main.json). 'CI passed' fails unless every CI job succeeds (https://github.com/ciatlas/flowpact/blob/main/.github/workflows/ci.yml). Renovate merges only when all checks are green. The other checks (CodeQL, code-scanning results) are informational, so merging past a failure in one of them is a manual action by the maintainer.


    ¡Suficiente para una insignia!

    Antes de que se acepte un commit, los pipelines de CI/CD del proyecto DEBEN ejecutar al menos un conjunto de pruebas automatizado para asegurar que los cambios cumplan las expectativas. [OSPS-QA-06.01]
    Las pruebas automatizadas deben ejecutarse antes de cada fusión en la rama principal. El conjunto de pruebas debe ejecutarse en un pipeline de CI/CD y los resultados deben ser visibles para todos los contribuidores. El conjunto de pruebas debe ejecutarse en un entorno consistente y debe ejecutarse de manera que permita a los contribuidores ejecutar las pruebas localmente. Ejemplos de conjuntos de pruebas incluyen pruebas unitarias, pruebas de integración y pruebas de extremo a extremo.

    On every pull request, CI's Test job runs the Vitest suite of unit, property and end-to-end tests (pnpm coverage) on Node 22 and 24 (https://github.com/ciatlas/flowpact/blob/main/.github/workflows/ci.yml). CI also smoke-tests the packed CLI on Linux, macOS and Windows and the extension in VS Code. The main ruleset requires the aggregate 'CI passed' check and has no bypass actors, so nothing merges without these tests.


    ¡Suficiente para una insignia!

    Cuando el proyecto ha realizado un lanzamiento, la documentación del proyecto DEBE incluir documentación de diseño que demuestre todas las acciones y actores dentro del sistema. [OSPS-SA-01.01]
    Incluya diseños en la documentación del proyecto que expliquen las acciones y los actores. Los actores incluyen cualquier subsistema o entidad que pueda influir en otro segmento del sistema. Asegúrese de que esto se actualice para nuevas características o cambios importantes.

    https://ciatlas.github.io/flowpact/docs/how-it-works describes the analysis step by step, from YAML to reports. https://github.com/ciatlas/flowpact/blob/main/CONTRIBUTING.md#repository-layout names each component: the core model, lint, reporters, CLI/API, action, language server and extension. https://ciatlas.github.io/flowpact/docs/security covers every actor and action around them: the analyzed repository as untrusted input, plugins, what flowpact writes, the Action's two network calls and its token, and permissions. The release workflow, release bot and Renovate are covered there and in https://github.com/ciatlas/flowpact/blob/main/CONTRIBUTING.md#releases.


    ¡Suficiente para una insignia!

    Cuando el proyecto haya realizado un lanzamiento, la documentación del proyecto DEBE incluir descripciones de todas las interfaces de software externas de los activos de software liberados. [OSPS-SA-02.01]
    Documente todas las interfaces de software (APIs) de los activos de software liberados, explicando cómo los usuarios pueden interactuar con el software y qué datos se esperan o se producen. Asegúrese de que esto se actualice para nuevas funcionalidades o cambios incompatibles.

    Reference docs cover every external interface of the released assets. The CLI's commands, options, output formats, JSON report, exit codes and environment variables: https://ciatlas.github.io/flowpact/docs/cli. The Action's inputs, outputs, annotations and permissions: https://ciatlas.github.io/flowpact/docs/action. The programmatic API: https://ciatlas.github.io/flowpact/docs/api. The config, with JSON Schemas: https://ciatlas.github.io/flowpact/docs/configuration. Contracts: https://ciatlas.github.io/flowpact/docs/contracts. The plugin API: https://ciatlas.github.io/flowpact/docs/custom-rules. The language server and extension settings: https://ciatlas.github.io/flowpact/docs/editors.


    ¡Suficiente para una insignia!

    Cuando el proyecto haya realizado un lanzamiento, el proyecto DEBE realizar una evaluación de seguridad para comprender los problemas de seguridad potenciales más probables e impactantes que podrían ocurrir dentro del software. [OSPS-SA-03.01]
    Realizar una evaluación de seguridad informa tanto a los miembros del proyecto como a los consumidores posteriores que el proyecto comprende qué problemas podrían surgir dentro del software. Comprender qué amenazas podrían materializarse ayuda al proyecto a gestionar y abordar el riesgo. Esta información es útil para los consumidores posteriores para demostrar la competencia y prácticas de seguridad del proyecto. Asegúrese de que esto se actualice para nuevas funcionalidades o cambios incompatibles.

    The threat model at https://ciatlas.github.io/flowpact/docs/threat-model ranks the most likely and impactful security problems by residual risk, each with the mitigation in the code, the tests that cover it and the risk that remains; CONTRIBUTING.md asks to revisit it for new features and breaking changes.


    ¡Suficiente para una insignia!

    La documentación del proyecto DEBE incluir una política de divulgación coordinada de vulnerabilidades (CVD), con un plazo claro de respuesta. [OSPS-VM-01.01]
    Cree un archivo SECURITY.md en la raíz del directorio, describiendo la política del proyecto para la divulgación coordinada de vulnerabilidades. Incluya un método para reportar vulnerabilidades. Establezca expectativas sobre cómo el proyecto responderá y abordará los problemas reportados.

    https://github.com/ciatlas/flowpact/blob/main/SECURITY.md is the coordinated disclosure policy, also shown at https://github.com/ciatlas/flowpact/security/policy. Reports go privately through GitHub's private vulnerability reporting, with an acknowledgement within 3 working days and an assessment within 10. The advisory is published once a fixed release is available, crediting the reporter.


    ¡Suficiente para una insignia!

    La documentación del proyecto DEBE proporcionar un medio para reportar vulnerabilidades de forma privada directamente a los contactos de seguridad del proyecto. [OSPS-VM-03.01]
    Proporcione un medio para que los investigadores de seguridad reporten vulnerabilidades de forma privada al proyecto. Esto puede ser una dirección de correo electrónico dedicada, un formulario web, herramientas especializadas del VCS, direcciones de correo electrónico para contactos de seguridad, u otros métodos.

    https://github.com/ciatlas/flowpact/blob/main/SECURITY.md#reporting-a-vulnerability directs reporters to GitHub's private vulnerability reporting form (https://github.com/ciatlas/flowpact/security/advisories/new) and not to public issues. The form is enabled for the repository, and reports reach the maintainer privately.


    ¡Suficiente para una insignia!

    La documentación del proyecto DEBE publicar públicamente los datos sobre las vulnerabilidades descubiertas. [OSPS-VM-04.01]
    Proporcione información sobre vulnerabilidades conocidas en un canal público predecible, como una entrada CVE, publicación de blog u otro medio. En la medida de lo posible, esta información debe incluir la(s) versión(es) afectada(s), cómo un consumidor puede determinar si es vulnerable, e instrucciones para la mitigación o remediación.

    Vulnerabilities fixed in past releases are published in https://github.com/ciatlas/flowpact/blob/main/SECURITY.md#security-fixes-in-past-releases with the affected versions, how to tell whether you are affected and the fix; future ones are published as GitHub security advisories (https://github.com/ciatlas/flowpact/security/advisories) and named in the release notes.



Puede utilizar herramientas y sistemas de IA para proponer cambios a través de una URL simple, como https://www.bestpractices.dev/es/projects/15403/choose/edit?osps_ac_01_01_status=Met&osps_ac_01_01_justification=GitHub+enforced. Consulte nuestro sistema de propuestas de automatización para saber cómo hacerlo. Estos datos están disponibles bajo el Acuerdo de Licencia de Datos de la Comunidad – Permisivo, Versión 2.0 (CDLA-Permissive-2.0). Esto significa que un Destinatario de Datos puede compartir los Datos, con o sin modificaciones, siempre que el Destinatario de Datos ponga a disposición el texto de este acuerdo con los Datos compartidos. Por favor, acredite a Ruman Kazi y a los colaboradores de la insignia de Mejores Prácticas de OpenSSF.

Entrada de insignia del proyecto propiedad de: Ruman Kazi.
Entrada creada el 2026-10-12 07:45:57 UTC, última actualización el 2026-10-12 10:15:42 UTC. Última obtención de la insignia de nivel básico el 2026-10-12 07:46:35 UTC.