zod-openapi

zod-openapi

This package is intended to be public on seek-oss. To create an internal package, run skuba init and select the private-npm-package template.

Next steps:

1. Read SEEK's Open Source RFC.
2. Create a new repository in the seek-oss GitHub organisation.
3. Push local commits to the upstream GitHub branch.
4. Configure GitHub repository settings.
5. Keep dependencies up to date with Renovate; request installation in #open-source.
6. Delete this checklist 😌.

API

log

Writes the module name to stdout. Thrilling stuff.

import { log } from 'zod-openapi';

log();

Development

Prerequisites

• Node.js LTS
• Yarn 1.x

yarn install

Test

yarn test

Lint

# Fix issues
yarn format

# Check for issues
yarn lint

Package

# Compile source
yarn build

# Review bundle
npm pack

Release

This package is published to the public npm registry with a GitHub Actions release workflow.

The workflow runs on select branches:

on:
  push:
    branches:
      # add others as necessary
      - beta
      - master
      # - alpha

It depends on this repo being hosted on seek-oss with appropriate access.

To set up this repo for publishing, follow the instructions in our OSS npm package guidance.

Commit messages

This package is published with semantic-release, which requires a particular commit format to manage semantic versioning. You can run the interactive yarn commit command in place of git commit to generate a compliant commit title and message. If you use the Squash and merge option on pull requests, take extra care to format the squashed commit in the GitHub UI before merging.

Releasing latest

Commits to the master branch will be released with the latest tag, which is the default used when running npm install or yarn install.

Releasing other dist-tags

semantic-release prescribes a branch-based workflow for managing distribution tags.

You can push to other branches to manage betas, maintenance updates to prior major versions, and more.

Here are some branches that semantic-release supports by default:

Git branch	npm dist-tag
master	latest
alpha	alpha
beta	beta
next	next
1.x	release-1.x

For more information, see the semantic-release docs on triggering a release.