Merge pull request #254 from iotaledger/dev

Release 0.3.0

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,47 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[Bug] "
+labels: bug
+assignees: ''
+
+---
+
+## Bug description
+Briefly describe the bug.
+
+## Language version
+What programming language are you using? Rust or one of the bindings?
+Which version of the language are you running?
+
+- Language:
+- Version:
+
+## IOTA Identity version
+Which version of IOTA Identity are you using?
+
+- Version (version number, commit, or branch):
+
+## Hardware specification
+What hardware are you using? (Delete if not relevant)
+
+- Operating system:
+- RAM:
+- Cores:
+- Device:
+
+## Steps To reproduce the bug
+Explain how the maintainer can reproduce the bug.
+
+1.
+2.
+3.
+
+## Expected behaviour
+Describe what you expect to happen.
+
+## Actual behaviour
+Describe what actually happens.
+
+## Errors
+Paste any errors that you see, including logs, errors, or screenshots.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Official Discord
+    url: https://discord.iota.org/
+    about: Contact the maintainers by joining the official Discord. Look for the channel #identity-discussion. 

.github/ISSUE_TEMPLATE/documentation-task.md

@@ -0,0 +1,21 @@
+---
+name: Documentation Task
+about: Add a documentation task (Only use when agreed upon by maintainers)
+title: "[Doc] "
+labels: documentation
+assignees: ''
+
+---
+
+## Description
+Describe the documentation task.
+
+## Reference material
+Links resources such as RFCs, specifications, and other documentation. 
+
+## To-do List
+Create a task-specific to-do list 
+
+- [ ] Item one
+- [ ] Item two
+- [ ] Item three

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,28 @@
+---
+name: Feature Request
+about: Request a feature for IOTA Identity
+title: "[Request]"
+labels: Request
+assignees: ''
+
+---
+
+## Description
+Briefly describe the feature that you are requesting.
+
+## Motivation
+Explain why this feature is needed.
+
+## Requirements
+Write a list of what you want this feature to do.
+
+1.
+2.
+3.
+
+## Open questions (optional)
+Use this section to ask any questions that are related to the feature.
+
+## Are you planning to do it yourself in a pull request?
+
+Yes/No

.github/ISSUE_TEMPLATE/task.md

@@ -0,0 +1,34 @@
+---
+name: Task
+about: Add a task (Only use when agreed upon by maintainers)
+title: "[Task] "
+labels: ''
+assignees: ''
+
+---
+
+## Description
+Describe the task, this may be scoped beyond a single PR.
+
+## Motivation
+Describe the motivation for the feature to be developed.
+
+## Resources
+Link to any resources relevant for the task such as Issues, PRs, reference implementations, or specifications.
+
+## To-do list
+Create a task-specific to-do list . Please link PRs that match the To-do list item behind the item after it has been submitted.
+
+- [ ] Item one
+- [ ] Item two
+- [ ] Item three
+
+## Change checklist
+Add an `x` to the boxes that are relevant to your changes, and delete any items that are not.
+
+- [ ] The feature or fix is implemented in Rust and across all bindings whereas possible.
+- [ ] The feature or fix has sufficient testing coverage
+- [ ] All tests and examples build and run locally as expected
+- [ ] Every piece of code has been document according to the documentation guidelines.
+- [ ] If conceptual documentation (mdbook) and examples highlighting the feature exist, they are properly updated.
+- [ ] If the feature is not currently documented, a documentation task Issue has been opened to address this. 

.github/pull_request_template.md

@@ -0,0 +1,27 @@
+# Description of change
+Please write a summary of your changes and why you made them.
+
+## Links to any relevant issues
+Be sure to reference any related issues by adding `fixes issue #`.
+
+## Type of change
+Add an `x` to the boxes that are relevant to your changes.
+
+- [ ] Bug fix (a non-breaking change which fixes an issue)
+- [ ] Enhancement (a non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation Fix
+
+## How the change has been tested
+Describe the tests that you ran to verify your changes.
+Make sure to provide instructions for the maintainer as well as any relevant configurations.
+
+## Change checklist
+Add an `x` to the boxes that are relevant to your changes.
+
+- [ ] I have followed the contribution guidelines for this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes

.github/workflows/build-and-test.yml

@@ -9,25 +9,18 @@ on:
     branches:
       - main
       - dev
-    paths-ignore:
-      - 'docs/**'
+    paths:
+      - '.github/workflows/format.yml'
+      - '**.rs'
+      - '**.toml'
 
 jobs:
   build-and-test:
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
-        project:
-          [
-            identity,
-            identity-core,
-            identity-credential,
-            identity-did,
-            identity-diff,
-            identity-iota,
-          ]
-        os: [ubuntu-latest, windows-latest]
+        os: [ubuntu-latest, macos-latest, windows-latest]
 
     steps:
       - uses: actions/checkout@v2
@@ -39,54 +32,100 @@ jobs:
           override: true
 
       - name: Get current date
-        if: matrix.os == 'ubuntu-latest'
+        if: matrix.os == 'macos-latest' || matrix.os == 'ubuntu-latest'
         run: echo "CURRENT_DATE=$(date +'%Y-%m-%d')" >> $GITHUB_ENV
 
       - name: Get current date
         if: matrix.os == 'windows-latest'
         run: echo "CURRENT_DATE=$(Get-Date -Format "yyyy-MM-dd")" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
 
       - name: Cache cargo registry
-        uses: actions/cache@v2
+        uses: actions/cache@v2.1.4
         with:
           path: ~/.cargo/registry
           # Add date to the cache to keep it up to date
-          key: ${{ matrix.project }}-${{ matrix.os }}-cargo-registry-${{ hashFiles('**/Cargo.toml') }}-${{ env.CURRENT_DATE }}
+          key: ${{ matrix.os }}-cargo-registry-${{ hashFiles('**/Cargo.toml') }}-${{ env.CURRENT_DATE }}
           # Restore from outdated cache for speed
           restore-keys: |
-            ${{ matrix.project }}-${{ matrix.os }}-cargo-registry-${{ hashFiles('**/Cargo.toml') }}
+            ${{ matrix.os }}-cargo-registry-${{ hashFiles('**/Cargo.toml') }}
 
       - name: Cache cargo index
-        uses: actions/cache@v2
+        uses: actions/cache@v2.1.4
         with:
           path: ~/.cargo/git
           # Add date to the cache to keep it up to date
-          key: ${{ matrix.project }}-${{ matrix.os }}-cargo-index-${{ hashFiles('**/Cargo.toml') }}-${{ env.CURRENT_DATE }}
+          key: ${{ matrix.os }}-cargo-index-${{ hashFiles('**/Cargo.toml') }}-${{ env.CURRENT_DATE }}
           # Restore from outdated cache for speed
           restore-keys: |
-            ${{ matrix.project }}-${{ matrix.os }}-cargo-index-${{ hashFiles('**/Cargo.toml') }}
+            ${{ matrix.os }}-cargo-index-${{ hashFiles('**/Cargo.toml') }}
 
       - name: Cache cargo target
-        uses: actions/cache@v2
+        uses: actions/cache@v2.1.4
         with:
-          path: ${{ matrix.project}}/target
+          path: target
           # Add date to the cache to keep it up to date
-          key: ${{ matrix.project }}-${{ matrix.os }}-cargo-build-target-${{ hashFiles('**/Cargo.toml') }}-${{ env.CURRENT_DATE }}
+          key: ${{ matrix.os }}-cargo-build-target-${{ hashFiles('**/Cargo.toml') }}-${{ env.CURRENT_DATE }}
           # Restore from outdated cache for speed
           restore-keys: |
-            ${{ matrix.project }}-${{ matrix.os }}-cargo-build-target-${{ hashFiles('**/Cargo.toml') }}
+            ${{ matrix.os }}-cargo-build-target-${{ hashFiles('**/Cargo.toml') }}
 
-      - name: Build ${{ matrix.project }}
+      - name: Cache wasm cargo target
+        uses: actions/[email protected]
+        with:
+          path: bindings/wasm/target
+          # Add date to the cache to keep it up to date
+          key: ${{ matrix.os }}-cargo-build-wasm-target-${{ hashFiles('**/Cargo.toml') }}-${{ env.CURRENT_DATE }}
+          # Restore from outdated cache for speed
+          restore-keys: |
+            ${{ matrix.os }}-cargo-build-wasm-target-${{ hashFiles('**/Cargo.toml') }}
+
+      - name: Cache libjose cargo target
+        uses: actions/[email protected]
+        with:
+          path: libjose/target
+          # Add date to the cache to keep it up to date
+          key: ${{ matrix.os }}-cargo-build-libjose-target-${{ hashFiles('**/Cargo.toml') }}-${{ env.CURRENT_DATE }}
+          # Restore from outdated cache for speed
+          restore-keys: |
+            ${{ matrix.os }}-cargo-build-libjose-target-${{ hashFiles('**/Cargo.toml') }}
+
+      - name: Build
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+          args: --all --release
+
+      - name: Run tests
+        uses: actions-rs/cargo@v1
+        with:
+          command: test
+          args: --all --release
+
+  build-and-test-libjose:
+    runs-on: ubuntu-latest
+    strategy:
+        fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install stable toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+
+      - name: Build
         uses: actions-rs/cargo@v1
         with:
           command: build
-          args: --manifest-path=${{ matrix.project }}/Cargo.toml --all --release
+          args: --manifest-path ./libjose/Cargo.toml --release
 
-      - name: Run tests for ${{ matrix.project }}
+      - name: Run tests
         uses: actions-rs/cargo@v1
         with:
           command: test
-          args: --manifest-path=${{ matrix.project }}/Cargo.toml --all --release
+          args: --manifest-path ./libjose/Cargo.toml --release
 
   build-and-test-wasm:
     runs-on: ubuntu-latest
@@ -111,7 +150,7 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v1
         with:
-          node-version: 12.x
+          node-version: 15.x
 
       - name: Install wasm-pack
         run: yarn global add wasm-pack
@@ -124,6 +163,8 @@ jobs:
         run: yarn build
         working-directory: bindings/wasm
 
-      # - name: Run tests
-      #   run: yarn test
-      #   working-directory: bindings/wasm
+      - name: Run tests
+        uses: actions-rs/cargo@v1
+        with:
+          command: test
+          args: --manifest-path ./bindings/wasm/Cargo.toml --release

.github/workflows/clippy.yml

@@ -9,25 +9,16 @@ on:
     branches:
       - main
       - dev
-    paths-ignore:
-      - 'docs/**'
+    paths:
+      - '.github/workflows/clippy.yml'
+      - '**.rs'
+      - '**.toml'
 
 jobs:
   clippy:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
-      matrix:
-        project:
-          [
-            identity,
-            identity-core,
-            identity-credential,
-            identity-did,
-            identity-diff,
-            identity-iota,
-            bindings/wasm,
-          ]
 
     steps:
       - uses: actions/checkout@v2
@@ -38,8 +29,21 @@ jobs:
           toolchain: stable
           override: true
           components: clippy
-      - uses: actions-rs/clippy-check@v1
+      - name: core clippy check
+        uses: actions-rs/clippy-check@v1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          args: --manifest-path=${{ matrix.project }}/Cargo.toml --all-targets --all-features -- -D warnings
-          name: clippy-${{ matrix.project }}
+          args: --all-targets --all-features -- -D warnings
+          name: core
+      - name: wasm clippy check
+        uses: actions-rs/clippy-check@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          args: --manifest-path ./bindings/wasm/Cargo.toml --all-targets --all-features -- -D warnings
+          name: wasm
+      - name: libjose clippy check
+        uses: actions-rs/clippy-check@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          args: --manifest-path ./libjose/Cargo.toml --all-targets --all-features -- -D warnings
+          name: libjose