-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ci: add manual trigger for docs update & extra documents
Signed-off-by: Ahmed Moussa <[email protected]>
- Loading branch information
Showing
10 changed files
with
279 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| To submit a new issue, please, use one of the following templates: | ||
|
|
||
| https://github.com/input-output-hk/atala-prism-didcomm-kmm/issues/new/choose | ||
|
|
||
| Thank you! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| --- | ||
| name: Bug Report | ||
| description: Report a bug in the Atala PRISM DIDComm | ||
|
|
||
| body: | ||
| - type: dropdown | ||
| id: is-regression | ||
| attributes: | ||
| label: Is this a regression? | ||
| options: | ||
| - 'Yes' | ||
| - 'No' | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Description | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: exception-or-error | ||
| attributes: | ||
| label: Please provide the exception or error you saw | ||
|
|
||
| - type: textarea | ||
| id: environment | ||
| attributes: | ||
| label: Please provide the environment you discovered this bug in | ||
|
|
||
| - type: textarea | ||
| id: other | ||
| attributes: | ||
| label: Anything else? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| --- | ||
| name: 'Feature Request' | ||
| description: Suggest a new feature for Atala PRISM DIDComm | ||
|
|
||
| body: | ||
| - type: textarea | ||
| id: proposed-feature | ||
| attributes: | ||
| label: Proposed feature | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Feature description | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: other | ||
| attributes: | ||
| label: Anything else? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| --- | ||
| blank_issues_enabled: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # Overview | ||
| <!-- What this PR does, and why is needed, a useful description is expected, and relevant tickets should be mentioned --> | ||
|
|
||
| Fixes #<issue number> | ||
|
|
||
| ## Checklist | ||
|
|
||
| ### My PR contains... | ||
| * [ ] No code changes (changes to documentation, CI, metadata, etc.) | ||
| * [ ] Bug fixes (non-breaking change which fixes an issue) | ||
| * [ ] Improvements (misc. changes to existing features) | ||
| * [ ] Features (non-breaking change which adds functionality) | ||
|
|
||
| ### My changes... | ||
| * [ ] are breaking changes | ||
| * [ ] are not breaking changes | ||
| * [ ] If yes to above: I have updated the documentation accordingly | ||
|
|
||
| ### Documentation | ||
| * [ ] My changes do not require a change to the project documentation | ||
| * [ ] My changes require a change to the project documentation | ||
| * [ ] If yes to above: I have updated the documentation accordingly | ||
|
|
||
| ### Tests | ||
| * [ ] My changes can not or do not need to be tested | ||
| * [ ] My changes can and should be tested by unit and/or integration tests | ||
| * [ ] If yes to above: I have added tests to cover my changes | ||
| * [ ] If yes to above: I have taken care to cover edge cases in my tests |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| --- | ||
| # kics-scan ignore | ||
| name: "Release Documentation" | ||
|
|
||
| defaults: | ||
| run: | ||
| shell: bash | ||
|
|
||
| env: | ||
| JAVA_VERSION: 11 | ||
| NODEJS_VERSION: 16.17.0 | ||
| ATALA_GITHUB_ACTOR: ${{ secrets.ATALA_GITHUB_ACTOR }} | ||
| ATALA_GITHUB_TOKEN: ${{ secrets.ATALA_GITHUB_TOKEN }} | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| push: | ||
| tags: | ||
| - "*" | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: "Checkout the repo" | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - name: "Validate Gradle Wrapper" | ||
| uses: gradle/wrapper-validation-action@v1 | ||
|
|
||
| - name: "Cache gradle" | ||
| uses: actions/cache@v3 | ||
| with: | ||
| path: | | ||
| ~/.gradle/caches | ||
| ~/.gradle/wrapper | ||
| ~/.konan | ||
| key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-gradle- | ||
| - name: "Install Java ${{ env.JAVA_VERSION }}" | ||
| uses: actions/setup-java@v3 | ||
| with: | ||
| java-version: ${{ env.JAVA_VERSION }} | ||
| distribution: "zulu" | ||
|
|
||
| - name: "Dokka Documentation Generation" | ||
| run: | | ||
| ./gradlew dokkaHtml | ||
| - name: "Push" | ||
| uses: s0/git-publish-subdir-action@develop | ||
| env: | ||
| REPO: self | ||
| BRANCH: gh-pages # The branch name where you want to push the assets | ||
| FOLDER: "apollo/build/dokka/html/" # The directory where your assets are generated | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # GitHub will automatically add this - you don't need to bother getting a token | ||
| MESSAGE: "feat(docs): ({sha}) {msg}" # The commit message |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| # Package io.iohk.atala.prism.apollo.base64 | ||
|
|
||
| [](http://kotlinlang.org) | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
|  | ||
|
|
||
| Apollo Base64 is Kotlin Multiplatform library containing: | ||
|
|
||
| - Standard | ||
| - URL safe | ||
|
|
||
| ## Supported Targets | ||
|
|
||
| | Platform | Supported | | ||
| |------------------------------------------|--------------------| | ||
| | iOS x86 64 | :heavy_check_mark: | | ||
| | iOS Arm 64 | :heavy_check_mark: | | ||
| | iOS Arm 32 | :heavy_check_mark: | | ||
| | iOS Simulator Arm 64 (Apple Silicon) | :heavy_check_mark: | | ||
| | JVM | :heavy_check_mark: | | ||
| | Android | :heavy_check_mark: | | ||
| | JS Browser | :heavy_check_mark: | | ||
| | NodeJS Browser | :heavy_check_mark: | | ||
| | macOS Arm 64 (Apple Silicon) | :heavy_check_mark: | | ||
|
|
||
| ## Usage | ||
|
|
||
| ### Base64 Standard | ||
|
|
||
| ```kotlin | ||
| val helloWorld = "V2VsY29tZSB0byBJT0c=".base64Decoded // "Hello, world!" | ||
| println("Welcome to IOG".base64Encoded) // Prints "SGVsbG8sIHdvcmxkIQ==" | ||
| ``` | ||
|
|
||
| ### Base64 URL | ||
|
|
||
| ```kotlin | ||
| val helloWorld = "V2VsY29tZSB0byBJT0c".base64UrlDecoded // "Hello, world!" | ||
| println("Welcome to IOG".base64UrlEncoded) // Prints "SGVsbG8sIHdvcmxkIQ" | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| # Package io.iohk.atala.prism.apollo.securerandom | ||
|
|
||
| [](http://kotlinlang.org) | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
|  | ||
|
|
||
| Apollo Secure Random is Kotlin Multiplatform library to generate secure random bytes | ||
|
|
||
| ## Supported Targets | ||
|
|
||
| | Platform | Supported | | ||
| |------------------------------------------|--------------------| | ||
| | iOS x86 64 | :heavy_check_mark: | | ||
| | iOS Arm 64 | :heavy_check_mark: | | ||
| | iOS Arm 32 | :heavy_check_mark: | | ||
| | iOS Simulator Arm 64 (Apple Silicon) | :heavy_check_mark: | | ||
| | JVM | :heavy_check_mark: | | ||
| | Android | :heavy_check_mark: | | ||
| | JS Browser | :heavy_check_mark: | | ||
| | NodeJS Browser | :heavy_check_mark: | | ||
| | macOS Arm 64 (Apple Silicon) | :heavy_check_mark: | | ||
|
|
||
| ## Usage | ||
|
|
||
| ```kotlin | ||
| val iv: ByteArray = SecureRandom().nextBytes(16) | ||
| val seed: ByteArray = SecureRandom.generateSeed(10) | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters