feat: publish on GitHub registry

bifravst · Sep 25, 2019 · 3ae9bd1 · 3ae9bd1
1 parent c765b62
commit 3ae9bd1
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 3 deletions.
diff --git a/.github/workflows/semantic-release.yaml b/.github/workflows/semantic-release.yaml
@@ -25,7 +25,7 @@ jobs:
       continue-on-error: true
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
       run: |
+        echo "//npm.pkg.github.com/:_authToken=$GITHUB_TOKEN" > ~/.npmrc
         npm i --no-save semantic-release@next
         npx semantic-release
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Bifravst TypeScript ESLint Config [![npm version](https://img.shields.io/npm/v/@bifravst/eslint-config-typescript.svg)](https://www.npmjs.com/package/@bifravst/eslint-config-typescript)
+# Bifravst TypeScript ESLint Config
 
 [![GitHub Actions](https://github.com/bifravst/eslint-config-typescript/workflows/Semantic%20Release/badge.svg)](https://github.com/bifravst/eslint-config-typescript/actions)
 [![Greenkeeper badge](https://badges.greenkeeper.io/bifravst/eslint-config-typescript.svg)](https://greenkeeper.io/)
@@ -12,3 +12,12 @@ ESLint configuration (with
 for all Bifravst projects.
 
 See [@bifravst/code-style](https://github.com/bifravst/code-style) for usage.
+
+## Installation
+
+> Note: This package is hosted on the GitHub package registry and
+> [npm needs to be configured](https://help.github.com/en/articles/configuring-npm-for-use-with-github-package-registry#installing-a-package)
+> in order to use it.
+
+    echo "@bifravst:registry=https://npm.pkg.github.com" >> .npmrc
+    npm i --save-dev @bifravst/eslint-config-typescript
diff --git a/package.json b/package.json
@@ -56,7 +56,8 @@
     "remoteTags": true
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "registry": "https://npm.pkg.github.com/"
   },
   "files": [
     "package-lock.json",