Skip to content

Commit

Permalink
Add changelog (#33)
Browse files Browse the repository at this point in the history
* adds CHANGELOG.md

* adds more updates to CHANGELOG.md

* adds CHANGELOG enforcing action
  • Loading branch information
jscyo authored Feb 9, 2022
1 parent e1ac8f7 commit 3b4e6c6
Show file tree
Hide file tree
Showing 2 changed files with 156 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .github/workflows/github-actions-changelog.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: "Enforcing changelog in PRs Workflow"
on:
pull_request:
types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]

jobs:
# Enforces the update of a changelog file on every pull request
changelog:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: dangoslen/changelog-enforcer@v2
with:
changeLogPath: 'CHANGELOG.md'
skipLabels: 'Skip-Changelog'
141 changes: 141 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)

## [2.12.0]

### Added
- Adds `userId` in response of `/recipe/user/password/reset API`

## [2.11.0]

### Added

- Passwordless recipe
- adds `/signinup/code/consume` POST
- adds `/signinup/code/remove` POST
- adds `/signinup/code` POST
- adds `/signinup/codes` GET
- adds `/signinup/codes/remove` POST

### Updated
- Core APIs
- updates `/user` GET with `passwordless` rid
- updates `/users` GET with `rid` and new `user` type

## [2.10.0]

### Added
- adds /user/remove POST

## [2.9.0]

### Added
- JWT recipe
- adds JWT validity to `/recipe/jwt` POST
- adds a new property `jwtSigningPublicKeyList` which lists valid JWT signing keys to the following API responses:
- `/recipe/handshake` POST
- `/recipe/session` POST
- `/recipe/session/verify` POST

### Updates
- Fixs response for `/users` GET

### Removed
- JWT recipe
- removes `JWT_CREATION_ERROR` from `/recipe/jwt` POST response

## [2.8.0]

### Deprecated
- Emailpassword recipe
- `/recipe/users/count` GET
- `/recipe/users` GET

- Thirdparty recipe
- `/recipe/users/count` GET
- `/recipe/users` GET

- Session Recipe
- `/recipe/session/data` GET
- `/recipe/jwt/data` GET

### Removed
- removes `isVerified` `boolean` from `/recipe/signinup` POST

### Added
- Core APIs
- adds `/users/count` GET
- adds `/users` GET

- Session Recipe
- adds `/recipe/session` GET

## [2.7.0]

### Added
- Third party recipe
- adds `/recipe/signinup` POST
- adds `/recipe/user` GET
- adds `/recipe/users` GET
- adds`/recipe/users/count` GET

### Changed
- Email verification
- Changed output of `/recipe/user/email/verify` to give `userId` instead of `user` object
- Email verification APIs no longer return `UNKNOWN_USER_ID_ERROR`
- Moved `/recipe/user/email/verify/token` to its own recipe
- Moved `/recipe/user/email/verify` to its own recipe
- Moved `/recipe/user/email/verify` to its own recipe

## [2.6.0]

### Updated
- `/recipe/handshake` GET
- `/recipe/session` POST
- `/recipe/session/verify` POST
- `/recipe/session/refresh` POST

[2.5.0]

### Added
- `/recipe/user/email/verify/token` POST
- `/recipe/user/email/verify` POST
- `/recipe/user/email/verify` GET
- `/recipe/users` GET
- `/recipe/count` GET

[2.4.0]

### Removed

- `accessTokenPath`, `refreshTokenPath`, `cookieSecure`, `cookieSameSite`, `idRefreshTokenPath`, `cookieDomain`, `sessionExpiredStatusCode` from `handshakeInfo`

### Updated
- In `/config`, `NOT ALLOWED` => `NOT_ALLOWED`
- `/hello` API no longer requires `CDI` version
- `/handshake` => `/recipe/handshake`
- No longer require `deviceDriverInfo`
- Added `accessTokenValidity` and `refreshTokenValidity` to Handshake API
- `/session` => `/recipe/session`
- `/session/remove` => `/recipe/session/remove`
- `/session/verify` => `/recipe/session/verify`
- `/session/refresh` => `/recipe/session/refresh`
- `/session/user` => `/recipe/session/user`
- `/session/regenerate` => `/recipe/session/regenerate`
- /session/data => /recipe/session/data
- `/jwt/data` => `/recipe/jwt/data`

### Added
- adds `/recipe/signin`
- adds `/recipe/signup`
- adds `/recipe/user`
- adds `/recipe/user/password/reset/token`
- adds `/recipe/user/password/reset`

### Removed
- Remove support code for older CDI versions:

0 comments on commit 3b4e6c6

Please sign in to comment.