npm.io
1.3.0 • Published yesterday

@estehsaan/backstage-plugin-catalog-backend-module-onboarding

Licence
Apache-2.0
Version
1.3.0
Deps
5
Size
23 kB
Vulns
0
Weekly
0
Stars
1

backstage-plugins

A standalone monorepo for Backstage plugins published under the @estehsaan npm scope, following the same workspace pattern as backstage/community-plugins.

Packages

Package Version Description
@estehsaan/backstage-plugin-onboarding npm Frontend onboarding checklist plugin
@estehsaan/backstage-plugin-onboarding-backend npm Backend for the onboarding plugin
@estehsaan/backstage-plugin-onboarding-common npm Shared types and permissions

Installation (for consumers)

# In your Backstage app
yarn --cwd packages/app add @estehsaan/backstage-plugin-onboarding

# In your Backstage backend
yarn --cwd packages/backend add @estehsaan/backstage-plugin-onboarding-backend

See CONTRIBUTING.md for full contribution and publishing instructions.

Repository Structure

workspaces/
  onboarding/              # workspace root (independent yarn workspace)
    plugins/
      onboarding/          # @estehsaan/backstage-plugin-onboarding
      onboarding-backend/  # @estehsaan/backstage-plugin-onboarding-backend
      onboarding-common/   # @estehsaan/backstage-plugin-onboarding-common
    package.json

Development

# Install all dependencies
yarn install

# Type check
yarn tsc

# Build all packages
yarn build:all

# Run the frontend plugin dev server
cd workspaces/onboarding/plugins/onboarding
yarn start

# Run tests
yarn test

Releasing

This repo uses semantic-release for automated versioning and publishing.

Commit conventions drive releases

Release type is inferred from Conventional Commit messages:

  • feat: triggers a minor release
  • fix: triggers a patch release
  • feat!: or a BREAKING CHANGE: footer triggers a major release
  • docs:, chore:, ci:, test: do not trigger a release
Automated publishing via GitHub Actions
  1. Open a PR with Conventional Commit-style commits
  2. Merge to main
  3. The Release workflow analyzes commits since the last release, bumps versions, publishes to npm, and updates release notes/changelog automatically

First-time setup: add an NPM_TOKEN secret to GitHub Actions — see CONTRIBUTING.md#github-actions--npm_token.

Contributing

See CONTRIBUTING.md for commit conventions, branch naming, semantic-release workflow, and more.

License

Apache-2.0

Keywords