@npo-start/types
v2.3.1
Published
NPO Start API typings
Readme
NPO START WEB TYPES
All API models used for NPO Start.
Releases are automated with semantic-release.
Note: semantic-release determines the next version from Git tags (not from the version field in package.json). If this repo already has an established version (currently 2.2.20), create a one-time baseline tag that matches it before enabling automated releases so the first semantic-release run doesn't start from 1.0.0.
Example workflow:
- Make your changes
- Optionally run
yarn buildlocally to verify your changes before opening a PR - Use a Conventional Commit style pull request title (for example:
feat:,fix:,chore:) - Open and merge a pull request into
main - GitHub Actions runs semantic-release on
main, publishes the package, and creates or updates the GitHub Release automatically
GitHub Release content
- Release name is generated automatically as
Release x.y.zfrom the semantic-release tag. - Release body is set to the merged pull request title (for the exact merge commit that triggered the workflow).
- Strict mode: the workflow fails when no exact merged PR matches the current commit.
- Strict mode: the workflow fails when more than one semantic-version tag points at the current commit.
- If no semantic-release tag exists on the current main commit, GitHub Release publishing is skipped.
Note: The release workflow intentionally does not use dependency caching, in line with npm Trusted Publishing guidelines for release builds.
Required repository secrets
- No npm token is required when Trusted Publishing is configured.
One-time npm setup (Trusted Publishing)
- Open npm package settings for
@npo-start/types. - Add a Trusted Publisher for GitHub Actions.
- Configure it for repository
Nederlandse-Publieke-Omroep/npo-start-web-types. - Select workflow file e.g.
release.yml.
