cnc-maxconnect-nodebb-plugin v0.0.1-semantically-released
@seek/cnc-maxconnect-nodebb-plugin
This package is intended to be private on SEEK-Jobs under the @seek
npm org.
To create a public package,
run skuba init
and select the oss-npm-package
template.
Next steps:
- Create a new repository in the SEEK-Jobs GitHub organisation.
- Follow Gutenberg instructions for installing on your repository.
- Push local commits to the upstream GitHub branch.
- Configure GitHub repository settings.
- Delete this checklist 😌.
API
log
Writes the module name to stdout. Thrilling stuff.
import { log } from '@seek/cnc-maxconnect-nodebb-plugin';
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 npm registry under the private @seek
npm org with Gutenberg, SEEK's central npm publishing pipeline.
It depends on this repo being hosted on SEEK-Jobs with appropriate access.
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.
2 years ago
2 years ago