Skip to content

Commit

Permalink
fix: prepare for test release
Browse files Browse the repository at this point in the history
  • Loading branch information
pamapa committed Jul 21, 2021
1 parent c015b96 commit 211e304
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 29 deletions.
22 changes: 22 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Publish
on:
release:
types: [created]

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
# Setup .npmrc file to publish to npm
- uses: actions/setup-node@v2
with:
node-version: '14.x'
registry-url: 'https://registry.npmjs.org'

- run: npm install
- run: npm run build
- run: npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,25 @@
![Pipeline](https://github.com/pamapa/oidc-client-ts/workflows/Release/badge.svg)

# oidc-client-ts
Library to provide OpenID Connect (OIDC) and OAuth2 protocol support for client-side, browser-based JavaScript client applications. Also included is support for user session and access token management.
Library to provide OpenID Connect (OIDC) and OAuth2 protocol support for client-side, browser-based JavaScript client
applications. Also included is support for user session and access token management.

This is a forked version of the [oidc-client-js](https://github.com/IdentityModel/oidc-client-js) library, which has been archived and is no longer maintained. This version has been refactored from JavaScript to TypeScript. Trying to keep the API, as compatible as possible.

However we are aiming to modernize and simplify some internal parts, which will have an effect on the API. See the [milestone](https://github.com/pamapa/oidc-client-ts/milestone/1) for more info. IE11 will no longer be supported.
This is a forked version of the [oidc-client-js](https://github.com/IdentityModel/oidc-client-js) library, which has
been archived and is no longer maintained. This version has been refactored from JavaScript to TypeScript. Trying to
keep the API as compatible as possible. However we are aiming to modernize and simplify the library, which will
have an effect on the API.

**Contributions and help is much appreciated!**


## Table of Contents
- [Documentation](#documentation)
- [Installation](#installation)
- [Building the Source](#building-the-source)
- [Contributing](#contributing)
- [License](#license)


## Documentation

Some initial docs are [here](https://github.com/IdentityModel/oidc-client-js/wiki).
Expand All @@ -26,9 +30,10 @@ Some initial docs are [here](https://github.com/IdentityModel/oidc-client-js/wik
Using [npm](https://npmjs.org/)

```bash
npm install react-oidc-context
npm install oidc-client-ts
```


## Building the Source

```bash
Expand All @@ -52,9 +57,10 @@ and then browse to [http://localhost:15000](http://localhost:15000).
npm test
```

## Contributing

## Contributing
All are welcome on the [issue tracker](https://github.com/pamapa/oidc-client-ts/issues).


## License
This project is licensed under the Apache-2.0 license. See the [LICENSE](https://github.com/pamapa/oidc-client-ts/blob/main/LICENSE) file for more info.
39 changes: 16 additions & 23 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,39 +1,32 @@
{
"name": "oidc-client",
"version": "1.11.5",
"name": "oidc-client-ts",
"version": "2.0.0-alpha0",
"description": "OpenID Connect (OIDC) & OAuth2 client library",
"repository": {
"type": "git",
"url": "git+https://github.com:pamapa/oidc-client-ts.git"
},
"homepage": "https://github.com/pamapa/oidc-client-ts#readme",
"license": "Apache-2.0",
"main": "dist/index.js",
"module": "dist/oidc-client.esm.js",
"module": "dist/oidc-client-ts.esm.js",
"typings": "dist/index.d.ts",
"files": [
"dist"
],
"keywords": [
"authentication",
"oauth2",
"oidc",
"openid",
"OpenID Connect"
],
"scripts": {
"start": "tsdx watch",
"build": "tsdx build",
"test": "tsdx test",
"lint": "tsdx lint"
},
"repository": {
"type": "git",
"url": "https://github.com/IdentityModel/oidc-client-js.git"
},
"author": "Brock Allen & Dominick Baier",
"contributors": [
{
"name": "Brock Allen",
"email": "brockallen@gmail.com"
},
{
"name": "Dominick Baier",
"email": "dbaier@leastprivilege.com"
}
],
"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/IdentityModel/oidc-client-js/issues"
},
"homepage": "https://github.com/IdentityModel/oidc-client-js",
"dependencies": {
"jsrsasign": "^10.3.0"
},
Expand Down

0 comments on commit 211e304

Please sign in to comment.