Merge pull request #199 from lawliet89/cut-0.6.0-beta1

Cut 0.6.0-beta1
lawliet89 · Feb 24, 2021 · 9148092 · 9148092
1 parent 678328f
commit 9148092
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 14 deletions.
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -41,11 +41,18 @@ jobs:
         if: matrix.rust == 'stable' && matrix.os == 'ubuntu-latest'
 
       - uses: actions-rs/cargo@v1
-        name: Clippy Lint
+        name: Clippy Lint (Stable)
         with:
           command: clippy
           args: --all-targets --all-features -- -D warnings
-        if: matrix.os == 'ubuntu-latest'
+        if: matrix.os == 'ubuntu-latest' && matrix.rust == 'stable'
+
+      - uses: actions-rs/cargo@v1
+        name: Clippy Lint (Non-stable)
+        with:
+          command: clippy
+          args: --all-targets --all-features -- -D warnings -A "clippy::upper_case_acronyms"
+        if: matrix.os == 'ubuntu-latest' && (matrix.rust == 'beta' || matrix.rust == 'nightly')
 
       - uses: actions-rs/cargo@v1
         name: Build

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.6.0-beta1 (2021-02-24)
+
+### Breaking Changes
+
+- [`jws::RegisteredHeader` field `web_key`](https://lawliet89.github.io/biscuit/biscuit/jws/struct.RegisteredHeader.html#structfield.web_key)
+  is now  of type `Option<jwk::JWK<Empty>>` instead of `Option<String>`. If you were not using JWKs,
+  continue setting the value to `None` will not breaking. If you were previously serializing your
+  JWK as JSON strings, you will now have to deserialize them into `jwk::JWK<Empty>`. Please raise
+  issues if you encounter any bugs. [[#189]](https://github.com/lawliet89/biscuit/pull/189)
+
+### Enhancements
+
+- Add support for Flattened JWS [[#190]](https://github.com/lawliet89/biscuit/pull/190)
+- Added more documentation for using OpenSSL to manipulate keys [[#179]](https://github.com/lawliet89/biscuit/pull/179)
+
 ## 0.5.0 (2020-11-17)
 
 ### Breaking Changes

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "biscuit"
-version = "0.5.0"
+version = "0.6.0-beta1"
 edition = "2018"
 authors = ["Yong Wen Chua <[email protected]>", "Vincent Prouillet <[email protected]>"]
 license = "MIT"

diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 [![Documentation](https://docs.rs/biscuit/badge.svg)](https://docs.rs/biscuit)
 [![dependency status](https://deps.rs/repo/github/lawliet89/biscuit/status.svg)](https://deps.rs/repo/github/lawliet89/biscuit)
 
-- Documentation:  [stable](https://docs.rs/biscuit/) | [master branch](https://lawliet89.github.io/biscuit)
+- Documentation:  [stable](https://docs.rs/biscuit/)
 - Changelog: [Link](https://github.com/lawliet89/biscuit/blob/master/CHANGELOG.md)
 
 A library to work with Javascript Object Signing and Encryption(JOSE),
@@ -19,7 +19,7 @@ This was based off [`Keats/rust-jwt`](https://github.com/Keats/rust-jwt).
 Add the following to Cargo.toml:
 
 ```toml
-biscuit = "0.5.0"
+biscuit = "0.6.0-beta1"
 ```
 
 To use the latest `master` branch, for example:

diff --git a/doc/README.md b/doc/README.md
@@ -3,4 +3,4 @@
 For API documentation, refer to the links below. This directory serves auxiliary documentation that are linked from
 the API documentation.
 
-[stable](https://docs.rs/biscuit/) | [master branch](https://lawliet89.github.io/biscuit)
+[stable](https://docs.rs/biscuit/)
diff --git a/doc/supported.md b/doc/supported.md
@@ -209,11 +209,11 @@ A list can be found
 
 ### JWS Serialization
 
-| Format         | Support | Remarks |
-|----------------|---------|---------|
-| Compact        |    ✔    |         |
-| General JSON   |    ✘    |         |
-| Flattened JSON |    ✘    |         |
+| Format         | Support | Remarks            |
+|----------------|---------|--------------------|
+| Compact        |    ✔    |                    |
+| General JSON   |    ✘    |                    |
+| Flattened JSON |    ✔    | As of v0.6.0-beta1 |
 
 ## JSON Web Encryption (JWE)
 

diff --git a/src/lib.rs b/src/lib.rs
@@ -4,7 +4,7 @@
 //! [![Documentation](https://docs.rs/biscuit/badge.svg)](https://docs.rs/biscuit)
 //! [![dependency status](https://deps.rs/repo/github/lawliet89/biscuit/status.svg)](https://deps.rs/repo/github/lawliet89/biscuit)
 //!
-//! - Documentation:  [stable](https://docs.rs/biscuit/) | [master branch](https://lawliet89.github.io/biscuit)
+//! - Documentation:  [stable](https://docs.rs/biscuit/)
 //! - Changelog: [Link](https://github.com/lawliet89/biscuit/blob/master/CHANGELOG.md)
 //!
 //! A library to work with Javascript Object Signing and Encryption(JOSE),
@@ -17,7 +17,7 @@
 //! Add the following to Cargo.toml:
 //!
 //! ```toml
-//! biscuit = "0.5.0"
+//! biscuit = "0.6.0-beta1"
 //! ```
 //!
 //! To use the latest `master` branch, for example: