eslint-config-skuba
Shareable ESLint config for skuba.
Table of contents
Usage
eslint-config-skuba is bundled with skuba.
You can start a new project:
npx skuba init
Or bootstrap an existing one:
# install skuba
yarn add --dev --exact skuba
# bootstrap your project
yarn skuba configure
Either method will leave you with an .eslintrc.js
:
module.exports = {
extends: ['skuba'],
};
Some scripts will be defined via package.json
:
# run ESLint in fix mode
yarn format
# run ESLint in check mode
yarn lint
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 access to the SEEK_OSS_CI_NPM_TOKEN
GitHub secret.
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.