Skip to content
This repository has been archived by the owner on Oct 3, 2022. It is now read-only.

Commit

Permalink
feat: publish on GitHub registry
Browse files Browse the repository at this point in the history
  • Loading branch information
coderbyheart committed Sep 25, 2019
1 parent 35e8c3c commit fc655de
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 4 deletions.
6 changes: 5 additions & 1 deletion .github/workflows/test-and-release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Install latest npm
run: |
sudo npm install -g npm@
npm config set update-notifier false
- name: Install dependencies
run: npm ci --no-audit
- name: Test
Expand All @@ -15,7 +19,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
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Modemtalk [![npm version](https://img.shields.io/npm/v/@bifravst/modemtalk.svg)](https://www.npmjs.com/package/@bifravst/modemtalk)
# Modemtalk

[![GitHub Actions](https://github.com/bifravst/modemtalk/workflows/Test%20and%20Release/badge.svg)](https://github.com/bifravst/modemtalk/actions)
[![Greenkeeper badge](https://badges.greenkeeper.io/bifravst/modemtalk.svg)](https://greenkeeper.io/)
Expand All @@ -10,6 +10,15 @@ Library to interface with the nRF9160 modem.

This is a stand-alone publication of the `modemtalk` folder from https://github.com/NordicSemiconductor/pc-nrfconnect-linkmonitor/.

## 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/modemtalk

## Usage

Install it as a dependency in your project:
Expand Down Expand Up @@ -43,4 +52,4 @@ turnOffModem()
### More examples

- see usage in the [Link Monitor](https://github.com/NordicSemiconductor/pc-nrfconnect-linkmonitor/search?q=modemport&unscoped_q=modemport)
- [a script to write TLS credentials](https://github.com/bifravst/aws/blob/15c65558419914d0d5b4bed5d4f98b3128957da3/cli/commands/flash-cert.ts)
- [a script to write TLS credentials](https://github.com/bifravst/aws/blob/15c65558419914d0d5b4bed5d4f98b3128957da3/cli/commands/flash-cert.ts)
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@
"remoteTags": true
},
"publishConfig": {
"access": "public"
"access": "public",
"registry": "https://npm.pkg.github.com/"
}
}

0 comments on commit fc655de

Please sign in to comment.