Skip to content

Commit

Permalink
kill things
Browse files Browse the repository at this point in the history
  • Loading branch information
samchungy committed Mar 20, 2024
1 parent 4e2f510 commit 3e41e02
Showing 1 changed file with 0 additions and 54 deletions.
54 changes: 0 additions & 54 deletions packages/eslint-config-skuba/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,57 +7,3 @@
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)

## 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 `pnpm 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

0 comments on commit 3e41e02

Please sign in to comment.