seek-oss / eslint-config-skuba

skuba extensions to eslint-config-seek

eslint-config-skuba

Shareable ESLint config for skuba.

Table of contents

• Usage
• Release
• Contributing

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.

eslint-config-skuba's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

• deps: lock file maintenance
• deps: eslint

Detected dependencies

github-actions

.github/workflows/codeql-analysis.yml

• actions/checkout v4
• github/codeql-action v2
• github/codeql-action v2
• github/codeql-action v2

.github/workflows/release.yml

• actions/checkout v4
• actions/setup-node v3

.github/workflows/validate.yml

• actions/checkout v4
• actions/setup-node v3

npm

package.json

• @types/eslint ^8.4.1
• @typescript-eslint/eslint-plugin ^6.13.2
• @typescript-eslint/parser ^6.13.2
• eslint-config-seek ^12.0.1
• eslint-plugin-jest ^27.6.0
• eslint-plugin-tsdoc ^0.2.14
• eslint-plugin-yml ^1.5.0
• eslint 8.28.0
• skuba 7.3.1
• typescript 5.3.3
• eslint >= 7.2
• typescript >= 3.9

nvm

.nvmrc

---

• Check this box to trigger a request for Renovate to run again on this repository

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

No npm token specified.

An npm token must be created and set in the NPM_TOKEN environment variable on your CI environment.

Please make sure to create an npm token and to set it in the NPM_TOKEN environment variable on your CI environment. The token must allow to publish to the registry https://registry.npmjs.org/.

---

Good luck with your project ✨

Your semantic-release bot 📦🚀