|
1 |
| -# eslint-config-skuba |
2 |
| - |
3 |
| -[](https://github.com/seek-oss/eslint-config-skuba/actions?query=workflow%3ARelease) |
4 |
| -[](https://github.com/seek-oss/eslint-config-skuba/actions?query=workflow%3AValidate) |
5 |
| -[](https://github.com/seek-oss/skuba) |
6 |
| - |
7 |
| -Shareable ESLint config for **[skuba]**. |
8 |
| - |
9 |
| -[skuba]: https://github.com/seek-oss/skuba |
10 |
| - |
11 |
| -## Table of contents |
12 |
| - |
13 |
| -- [Usage](#usage) |
14 |
| -- [Release](#release) |
15 |
| -- [Contributing](https://github.com/seek-oss/eslint-config-skuba/blob/master/CONTRIBUTING.md) |
16 |
| - |
17 |
| -## Usage |
18 |
| - |
19 |
| -**eslint-config-skuba** is bundled with **skuba**. |
20 |
| - |
21 |
| -You can start a new project: |
22 |
| - |
23 |
| -```shell |
24 |
| -npx skuba init |
25 |
| -``` |
26 |
| - |
27 |
| -Or bootstrap an existing one: |
28 |
| - |
29 |
| -```shell |
30 |
| -# install skuba |
31 |
| -yarn add --dev --exact skuba |
32 |
| - |
33 |
| -# bootstrap your project |
34 |
| -yarn skuba configure |
35 |
| -``` |
36 |
| - |
37 |
| -Either method will leave you with an `.eslintrc.js`: |
38 |
| - |
39 |
| -```typescript |
40 |
| -module.exports = { |
41 |
| - extends: ['skuba'], |
42 |
| -}; |
43 |
| -``` |
44 |
| - |
45 |
| -Some scripts will be defined via `package.json`: |
46 |
| - |
47 |
| -```shell |
48 |
| -# run ESLint in fix mode |
49 |
| -yarn format |
50 |
| - |
51 |
| -# run ESLint in check mode |
52 |
| -yarn lint |
53 |
| -``` |
54 |
| - |
55 |
| -## Release |
56 |
| - |
57 |
| -This package is published to the public npm registry with a GitHub Actions [release workflow]. |
58 |
| - |
59 |
| -The workflow runs on select branches: |
60 |
| - |
61 |
| -```yaml |
62 |
| -on: |
63 |
| - push: |
64 |
| - branches: |
65 |
| - # add others as necessary |
66 |
| - - beta |
67 |
| - - master |
68 |
| - # - alpha |
69 |
| -``` |
70 |
| - |
71 |
| -It depends on this repo being hosted on [seek-oss] with access to the `SEEK_OSS_CI_NPM_TOKEN` GitHub secret. |
72 |
| - |
73 |
| -### Releasing latest |
74 |
| - |
75 |
| -Commits to the `master` branch will be released with the `latest` tag, |
76 |
| -which is the default used when running `npm install` or `yarn install`. |
77 |
| - |
78 |
| -### Releasing other dist-tags |
79 |
| - |
80 |
| -**[semantic-release]** prescribes a branch-based workflow for managing [distribution tags]. |
81 |
| - |
82 |
| -You can push to other branches to manage betas, maintenance updates to prior major versions, and more. |
83 |
| - |
84 |
| -Here are some branches that **semantic-release** supports by default: |
85 |
| - |
86 |
| -| Git branch | npm dist-tag | |
87 |
| -| :--------- | :----------- | |
88 |
| -| master | latest | |
89 |
| -| alpha | alpha | |
90 |
| -| beta | beta | |
91 |
| -| next | next | |
92 |
| -| 1.x | release-1.x | |
93 |
| - |
94 |
| -For more information, see the **semantic-release** docs on [triggering a release]. |
95 |
| - |
96 |
| -[distribution tags]: https://docs.npmjs.com/adding-dist-tags-to-packages |
97 |
| -[release workflow]: .github/workflows/release.yml |
98 |
| -[seek-oss]: https://github.com/seek-oss |
99 |
| -[seek's open source rfc]: https://rfc.skinfra.xyz/RFC016-Open-Source.html |
100 |
| -[semantic-release]: https://github.com/semantic-release/semantic-release |
101 |
| -[triggering a release]: https://github.com/semantic-release/semantic-release/#triggering-a-release |
| 1 | +This package has been relocated to https://github.com/seek-oss/skuba/blob/master/packages/eslint-config-skuba/ |
0 commit comments