This repository has been archived by the owner on Apr 12, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
1 addition
and
101 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,101 +1 @@ | ||
| # eslint-config-skuba | ||
|
|
||
| [](https://github.com/seek-oss/eslint-config-skuba/actions?query=workflow%3ARelease) | ||
| [](https://github.com/seek-oss/eslint-config-skuba/actions?query=workflow%3AValidate) | ||
| [](https://github.com/seek-oss/skuba) | ||
|
|
||
| Shareable ESLint config for **[skuba]**. | ||
|
|
||
| [skuba]: https://github.com/seek-oss/skuba | ||
|
|
||
| ## Table of contents | ||
|
|
||
| - [Usage](#usage) | ||
| - [Release](#release) | ||
| - [Contributing](https://github.com/seek-oss/eslint-config-skuba/blob/master/CONTRIBUTING.md) | ||
|
|
||
| ## Usage | ||
|
|
||
| **eslint-config-skuba** is bundled with **skuba**. | ||
|
|
||
| You can start a new project: | ||
|
|
||
| ```shell | ||
| npx skuba init | ||
| ``` | ||
|
|
||
| Or bootstrap an existing one: | ||
|
|
||
| ```shell | ||
| # install skuba | ||
| yarn add --dev --exact skuba | ||
|
|
||
| # bootstrap your project | ||
| yarn skuba configure | ||
| ``` | ||
|
|
||
| Either method will leave you with an `.eslintrc.js`: | ||
|
|
||
| ```typescript | ||
| module.exports = { | ||
| extends: ['skuba'], | ||
| }; | ||
| ``` | ||
|
|
||
| Some scripts will be defined via `package.json`: | ||
|
|
||
| ```shell | ||
| # 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: | ||
|
|
||
| ```yaml | ||
| 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]. | ||
|
|
||
| [distribution tags]: https://docs.npmjs.com/adding-dist-tags-to-packages | ||
| [release workflow]: .github/workflows/release.yml | ||
| [seek-oss]: https://github.com/seek-oss | ||
| [seek's open source rfc]: https://rfc.skinfra.xyz/RFC016-Open-Source.html | ||
| [semantic-release]: https://github.com/semantic-release/semantic-release | ||
| [triggering a release]: https://github.com/semantic-release/semantic-release/#triggering-a-release | ||
| This package has been relocated to https://github.com/seek-oss/skuba/blob/master/packages/eslint-config-skuba/ |