Releasing
How Olgax DXP packages are versioned and published to npm with Changesets, the automated Version Packages pull request and npm Trusted Publishing.
The @olgax.com/* packages and create-olgax-site are versioned with Changesets
and published to npm by GitHub Actions.
Which packages are published
@olgax.com/sdk@olgax.com/components@olgax.com/datasource@olgax.com/payload-presetcreate-olgax-site
apps/demo and apps/docs are never published. packages/marketplace and packages/multi-tenancy are groundwork and
excluded for now. See .changeset/config.json.
Add a changeset
If your PR changes anything in a published package, add a changeset:
pnpm changesetPick the affected packages and a semver bump, then write a one-line summary. It becomes the changelog entry. Commit
the generated .changeset/*.md file with your PR.
| Bump | Use for |
|---|---|
| patch | Bug fixes, docs and README updates |
| minor | New features |
| major | Breaking changes |
What happens next
Merge to main
CI runs lint, build and tests. If there are pending changesets, the release workflow opens or updates a Version Packages pull request.
Merge Version Packages
Merging bumps versions, updates changelogs and publishes to npm.
Provenance
Publishing uses npm Trusted Publishing (OIDC), so releases are tied to this repository's workflow.
The docs site
The docs are not released with Changesets. They are deployed from main, so docs-only changes need no changeset.
Questions, ideas or something not working?
Ask in our official Discord, open an issue on GitHub, or edit this page.
Default components
Add a component to the shared @olgax.com/components library - a 15 minute walkthrough that builds a Spacer block with registerComponent and CSS tokens.
Community
Join the official Olgax DXP Discord, report bugs on GitHub, find the docs at dxp.olgax.com and learn how to contribute to the open-source page builder.