# @kubernetes-models/shipwright

> Shipwright models

Latest version **2.0.0** (published 2026-05-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install @kubernetes-models/shipwright
pnpm add @kubernetes-models/shipwright
yarn add @kubernetes-models/shipwright
bun add @kubernetes-models/shipwright
```

## Health

**Score 60/100 (C)** — status: active.

Positive: esm support; no vulnerabilities; has provenance; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2026-05-14 |
| First published | 2023-10-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Node | >=22 |
| Dependencies | 4 |
| Unpacked size | 586.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 163 |
| Author | Christoph Jerolimov <jerolimov@redhat.com> |
| Maintainers | tommy351 |
| Keywords | kubernetes, kubernetes-models, tekton, tektoncd, shipwright |

## Links

- npm: https://www.npmjs.com/package/@kubernetes-models/shipwright
- Repository: https://github.com/tommy351/kubernetes-models-ts
- Homepage: https://github.com/tommy351/kubernetes-models-ts/tree/master/third-party/shipwright
- npm.io page: https://npm.io/package/@kubernetes-models/shipwright

## Dependencies (4)

- [kubernetes-models](https://npm.io/package/kubernetes-models.md) ^5.1.0
- [@kubernetes-models/base](https://npm.io/package/@kubernetes-models/base.md) ^6.0.1
- [@kubernetes-models/validate](https://npm.io/package/@kubernetes-models/validate.md) ^5.0.2
- [@kubernetes-models/apimachinery](https://npm.io/package/@kubernetes-models/apimachinery.md) ^3.0.2

## Recent versions

- 2.0.0 (latest) — 2026-05-14
- 0.0.0-20240610074310 (snapshot) — 2024-06-10
- 1.0.1 — 2026-05-06
- 1.0.0 — 2026-05-03
- 0.3.4 — 2025-08-16
- 0.3.3 — 2025-07-16
- 0.3.2 — 2024-12-08
- 0.3.1 — 2024-11-25
- 0.3.0 — 2024-06-10
- 0.0.0-20240608155033 — 2024-06-08
- 0.2.1 — 2024-06-08
- 0.0.0-20240608085410 — 2024-06-08
- 0.0.0-20240403022011 — 2024-04-03
- 0.0.0-20240402180946 — 2024-04-02
- 0.0.0-20240402174322 — 2024-04-02
- … 3 more at https://npm.io/package/@kubernetes-models/shipwright/versions

## README

# @kubernetes-models/shipwright

[Shipwright](https://shipwright.io/) models.

## Installation

Install with npm.

```sh
npm install @kubernetes-models/shipwright
```

## Usage

Models contains the v1alpha1 version for the Shipwright Operator up to version 0.11 and the v1beta1 version that is part of the Shipwright Operator version 0.12+.

```js
import { Build } from "@kubernetes-models/shipwright/shipwright.io/v1beta1/Build";
import { BuildRun } from "@kubernetes-models/shipwright/shipwright.io/v1beta1/BuildRun";

// Create a new Build
const build = new Build({
  metadata: {
    name: "buildah-golang-build",
  },
  spec: {
    strategy: {
      kind: 'ClusterBuildStrategy',
      name: 'buildah',
    },
    source: {
      git: {
        url: 'https://github.com/shipwright-io/sample-go',
      },
      contextDir: 'docker-build',
    },
    output: {
      image: 'registry/namespace/image:latest',
    },
  },
});

// Validate against JSON schema
build.validate();

// Create a BuildRun that links that Build
const buildRun = new Build({
  metadata: {
    generateName: "buildah-golang-build-",
  },
  spec: {
    build: {
      name: 'buildah-golang-build',
    },
  },
});

// Validate against JSON schema
buildRun.validate();
```

## License

MIT

---
_Source: https://npm.io/package/@kubernetes-models/shipwright · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._