From 9c5eb6969f515048381fec495462a50dca6db85a Mon Sep 17 00:00:00 2001 From: mkbreuningIOHK Date: Fri, 17 May 2024 17:41:24 +0800 Subject: [PATCH] fix: documentation generation failure and renaming update Signed-off-by: mkbreuningIOHK --- .github/CODEOWNERS | 2 +- .github/ISSUE_TEMPLATE/1-bug-report.yaml | 2 +- .github/ISSUE_TEMPLATE/2-feature-request.yaml | 2 +- .github/PULL_REQUEST_TEMPLATE.md | 12 ++++++------ .github/workflows/releaseDocumentation.yml | 2 +- README.md | 3 ++- package.json | 4 ++-- 7 files changed, 14 insertions(+), 13 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index a0df28ae..cfce22de 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,4 +1,4 @@ -@goncalo-frade-iohk @yshyn-iohk @elribonazo +* @goncalo-frade-iohk @elribonazo # Test related: /Sample/ @amagyar-iohk @todorkoleviohk @goncalo-frade-iohk diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.yaml b/.github/ISSUE_TEMPLATE/1-bug-report.yaml index 27c0e95a..16ac2ee5 100644 --- a/.github/ISSUE_TEMPLATE/1-bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/1-bug-report.yaml @@ -1,5 +1,5 @@ name: Bug Report -description: Report a bug in the Atala PRISM Swift SDK +description: Report a bug in the Edge Agent SDK Swift body: - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.yaml b/.github/ISSUE_TEMPLATE/2-feature-request.yaml index f50289bf..f031b9ba 100644 --- a/.github/ISSUE_TEMPLATE/2-feature-request.yaml +++ b/.github/ISSUE_TEMPLATE/2-feature-request.yaml @@ -1,5 +1,5 @@ name: 'Feature Request' -description: Suggest a new feature for Atala PRISM Swift SDK +description: Suggest a new feature for Edge Agent SDK Swift body: - type: textarea diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 21c1b144..26e4bc9b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -6,9 +6,9 @@ Link to any discussion, related issues and bug reports to give the context to he Link to existing ADR (Architecture Decision Record), if any. If relevant, describe other approaches explored and the selected approach. Documenting why the methods were not selected will create a knowledge base for future reference, helping prevent others from revisiting less optimal ideas. ### Checklist: -- [] My PR follows the [contribution guidelines](https://github.com/input-output-hk/atala-prism-wallet-sdk-swift/blob/main/CONTRIBUTING.md) of this project -- [] My PR is free of third-party dependencies that don't comply with the [Allowlist](https://toc.hyperledger.org/governing-documents/allowed-third-party-license-policy.html#approved-licenses-for-allowlist) -- [] 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 -- [] I have checked the PR title to follow the [conventional commit specification](https://www.conventionalcommits.org/en/v1.0.0/) +- [ ] My PR follows the [contribution guidelines](https://github.com/input-output-hk/atala-prism-wallet-sdk-swift/blob/main/CONTRIBUTING.md) of this project +- [ ] My PR is free of third-party dependencies that don't comply with the [Allowlist](https://toc.hyperledger.org/governing-documents/allowed-third-party-license-policy.html#approved-licenses-for-allowlist) +- [ ] 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 +- [ ] I have checked the PR title to follow the [conventional commit specification](https://www.conventionalcommits.org/en/v1.0.0/) diff --git a/.github/workflows/releaseDocumentation.yml b/.github/workflows/releaseDocumentation.yml index 16613fd1..3746fe05 100644 --- a/.github/workflows/releaseDocumentation.yml +++ b/.github/workflows/releaseDocumentation.yml @@ -43,7 +43,7 @@ jobs: max_attempts: 6 retry_on: error timeout_minutes: 50 - command: xcodebuild docbuild -scheme AtalaPrismSDK -destination "platform=macOS" -derivedDataPath ./doccBuild OTHER_DOCC_FLAGS="--transform-for-static-hosting --output-path ./docc --hosting-base-path '/atala-prism-wallet-sdk-swift'" + command: xcodebuild docbuild -scheme EdgeAgentSDK -destination "platform=macOS" -derivedDataPath ./doccBuild OTHER_DOCC_FLAGS="--transform-for-static-hosting --output-path ./docc --hosting-base-path '/atala-prism-wallet-sdk-swift'" - name: Upload artifact uses: actions/upload-pages-artifact@v1 diff --git a/README.md b/README.md index 8c71ab2b..916c9e1f 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,8 @@ The complete platform is separated into multiple repositories: * [edge-agent-sdk-swift](https://github.com/input-output-hk/atala-prism-wallet-sdk-swift) - Repo that implements Edge Agent for Apple platforms in Swift. * [edge-agent-wallet-sdk-ts](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts) - Repo that implements Edge Agent for Browser and NodeJS platforms in Typescript. -* [edge-agent-building-blocks](https://github.com/hyperledger-labs/open-enterprise-agent) - Repo that contains the platform Building Blocks. +* [edge-agent-wallet-sdk-kmp](https://github.com/input-output-hk/atala-prism-wallet-sdk-kmm) - Repo that implements Edge Agent for Android and JVM platforms in Kotlin Multi-Platform. +* [identus-cloud-agent](https://github.com/hyperledger/identus-cloud-agent) - Repo that contains the platform Building Blocks. * [mediator](https://github.com/input-output-hk/atala-prism-mediator) - Repo for DIDComm V2 Mediator ### Modules / APIs diff --git a/package.json b/package.json index 89ee61aa..658c7f77 100644 --- a/package.json +++ b/package.json @@ -52,7 +52,7 @@ "package.json", "package-lock.json" ], - "message": "chore(release): cut wallet sdk swift ${nextRelease.version} release\n\n${nextRelease.notes}" + "message": "chore(release): cut edge agent sdk swift ${nextRelease.version} release\n\n${nextRelease.notes}" } ], [ @@ -62,7 +62,7 @@ "notifyOnFail": true, "markdownReleaseNotes": true, "onSuccessTemplate": { - "text": "A new version of Swift Wallet SDK successfully released!\nVersion: `$npm_package_version`\nTag: $repo_url/releases/tag/$npm_package_version\n\nRelease notes:\n$release_notes" + "text": "A new version of Edge Agent SDK Swift successfully released!\nVersion: `$npm_package_version`\nTag: $repo_url/releases/tag/$npm_package_version\n\nRelease notes:\n$release_notes" } } ]