npm · Schema

TrustedPublisherRequest

Request body for adding a trusted publisher configuration.

PackagesJavaScriptNode.jsPackage ManagementRegistrySecurity

Properties

Name Type Description
provider string The CI/CD provider name.
repository_owner string The owner or namespace of the source repository.
repository string The name of the source repository.
workflow_filename string The workflow file that is trusted to publish. Required for GitHub Actions.
environment string The deployment environment name to restrict publishing to.
View JSON Schema on GitHub

JSON Schema

npm-trustedpublisherrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TrustedPublisherRequest",
  "title": "TrustedPublisherRequest",
  "type": "object",
  "description": "Request body for adding a trusted publisher configuration.",
  "required": [
    "provider",
    "repository_owner",
    "repository"
  ],
  "properties": {
    "provider": {
      "type": "string",
      "description": "The CI/CD provider name.",
      "enum": [
        "github-actions",
        "gitlab-ci",
        "circleci"
      ]
    },
    "repository_owner": {
      "type": "string",
      "description": "The owner or namespace of the source repository."
    },
    "repository": {
      "type": "string",
      "description": "The name of the source repository."
    },
    "workflow_filename": {
      "type": "string",
      "description": "The workflow file that is trusted to publish. Required for GitHub Actions."
    },
    "environment": {
      "type": "string",
      "description": "The deployment environment name to restrict publishing to."
    }
  }
}