Skip to content

Commit

Permalink
Basic docs around publishing, and bumped version (manchester-fertilit…
Browse files Browse the repository at this point in the history
…y-org#3)

* Basic docs around publishing, and bumped version

* Add PR action
  • Loading branch information
cobuso authored Jun 16, 2023
1 parent 2012f52 commit d44d35b
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 1 deletion.
21 changes: 21 additions & 0 deletions .github/workflows/pull-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Pull request

on:
pull_request:
branches: [master]

jobs:
publish:
name: Build & Publish Package
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 16.x
registry-url: https://npm.pkg.github.com/
- run: npm ci
- run: npm test
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@ connect.

Please see for more details: https://github.com/pladaria/reconnecting-websocket/issues/165

## Publishing to Github Packages

A Github actions workflow has been created to automatically publish new versions of this package to
Github Packages. To publish a new version:

- Bump the version number in package.json
- Run the "Publish Package to GitHub Packages" workflow

## Features

- WebSocket API compatible (same interface, Level0 and Level2 event model)
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@manchester-fertility-org/reconnecting-websocket",
"type": "module",
"version": "4.4.0",
"version": "4.4.1",
"description": "Reconnecting WebSocket",
"main": "./dist/reconnecting-websocket-cjs.js",
"module": "./dist/reconnecting-websocket-mjs.js",
Expand Down

0 comments on commit d44d35b

Please sign in to comment.