From c33ea9f5092b720884f87f275e61a0fd79dc3bfd Mon Sep 17 00:00:00 2001 From: YoonGyu Lee Date: Mon, 28 Oct 2024 18:23:44 +0900 Subject: [PATCH 1/4] docs(license): Modify file name from License-dependencies.md to dependencies-license.md and update the guide to reflect the changes. Additionally, removed Korean comments from the Dockerfile for consistency and clarity. --- README.md | 10 +++++----- LICENSE-dependencies.md => dependencies-license.md | 0 ...OpenDID_TASServer_InstallationAndOperation_Guide.md | 8 ++++---- ...nDID_TASServer_InstallationAndOperation_Guide_ko.md | 6 +++--- source/did-ta-server/Dockerfile | 6 ------ 5 files changed, 12 insertions(+), 18 deletions(-) rename LICENSE-dependencies.md => dependencies-license.md (100%) diff --git a/README.md b/README.md index 770ddc1..7cd09c5 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,13 @@ This repository contains the source code, documentation, and related resources f Overview of the major folders and documents in the project directory: ``` -did-tas-server +did-ta-server ├── CHANGELOG.md ├── CLA.md ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE -├── LICENSE-dependencies.md +├── dependencies-license.md ├── MAINTAINERS.md ├── README.md ├── RELEASE-PROCESS.md @@ -29,7 +29,7 @@ did-tas-server │   └── db │   └── OpenDID_TableDefinition_TAS.md └── source - └── did-tas-server + └── did-ta-server ├── gradle ├── libs └── did-sdk-common-1.0.0.jar @@ -54,7 +54,7 @@ Below is a description of each folder and file in the directory: | CODE_OF_CONDUCT.md | Code of conduct for contributors | | CONTRIBUTING.md | Contribution guidelines and procedures | | LICENSE | License | -| LICENSE-dependencies.md | Licenses for the project’s dependency libraries | +| dependencies-license.md | Licenses for the project’s dependency libraries | | MAINTAINERS.md | Guidelines for project maintainers | | RELEASE-PROCESS.md | Procedures for releasing new versions | | SECURITY.md | Security policies and vulnerability reporting | @@ -64,7 +64,7 @@ Below is a description of each folder and file in the directory: | ┖ installation | Installation and setup instructions | | ┖ db | Database ERD, Table Specifications | | source | Server source code project | -| ┖ did-tas-server | TAS Server source code and build files | +| ┖ did-ta-server | TAS Server source code and build files | | ┖ gradle | Gradle build configurations and scripts | | ┖ libs | External libraries and dependencies | | ┖ sample | Sample files | diff --git a/LICENSE-dependencies.md b/dependencies-license.md similarity index 100% rename from LICENSE-dependencies.md rename to dependencies-license.md diff --git a/docs/installation/OpenDID_TASServer_InstallationAndOperation_Guide.md b/docs/installation/OpenDID_TASServer_InstallationAndOperation_Guide.md index 56a7978..f7c1438 100644 --- a/docs/installation/OpenDID_TASServer_InstallationAndOperation_Guide.md +++ b/docs/installation/OpenDID_TASServer_InstallationAndOperation_Guide.md @@ -176,7 +176,7 @@ did-ta-server ├── CLA.md ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md -├── LICENSE-dependencies.md +├── dependencies-license.md ├── MAINTAINERS.md ├── README.md ├── RELEASE-PROCESS.md @@ -193,7 +193,7 @@ did-ta-server │   └── OpenDID_ERD_TAS.png │   └── OpenDID_TableDefinition_TAS.md └── source - └── did-tas-server + └── did-ta-server ├── gradle ├── libs └── did-sdk-common-1.0.0.jar @@ -213,7 +213,7 @@ did-ta-server | CHANGELOG.md | Changes by version for the project | | CODE_OF_CONDUCT.md | Code of conduct for contributors | | CONTRIBUTING.md | Contribution guidelines and procedures | -| LICENSE-dependencies.md | License information for project dependencies | +| dependencies-license.md | License information for project dependencies | | MAINTAINERS.md | Guidelines for project maintainers | | RELEASE-PROCESS.md | Procedure for releasing a new version | | SECURITY.md | Security policy and vulnerability reporting | @@ -223,7 +223,7 @@ did-ta-server | ┖ installation | Installation and configuration guide | | ┖ db | Database ERD and table specifications | | source | Source code | -| ┖ did-tas-server | TAS server source code and build files | +| ┖ did-ta-server | TAS server source code and build files | | ┖ gradle | Gradle build configuration and scripts | | ┖ libs | External libraries and dependencies | | ┖ sample | Sample files | diff --git a/docs/installation/OpenDID_TASServer_InstallationAndOperation_Guide_ko.md b/docs/installation/OpenDID_TASServer_InstallationAndOperation_Guide_ko.md index 5d573e7..835ed18 100644 --- a/docs/installation/OpenDID_TASServer_InstallationAndOperation_Guide_ko.md +++ b/docs/installation/OpenDID_TASServer_InstallationAndOperation_Guide_ko.md @@ -178,7 +178,7 @@ did-ta-server ├── CLA.md ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md -├── LICENSE-dependencies.md +├── dependencies-license.md ├── MAINTAINERS.md ├── README.md ├── RELEASE-PROCESS.md @@ -193,7 +193,7 @@ did-ta-server │   └── db │   └── OpenDID_TableDefinition_TAS.md └── source - └── did-tas-server + └── did-ta-server ├── gradle ├── libs └── did-sdk-common-1.0.0.jar @@ -213,7 +213,7 @@ did-ta-server | CHANGELOG.md | 프로젝트의 버전별 변경 사항 | | CODE_OF_CONDUCT.md | 기여자들을 위한 행동 강령 | | CONTRIBUTING.md | 기여 지침 및 절차 | -| LICENSE-dependencies.md | 프로젝트 의존 라이브러리의 라이선스 정보 | +| dependencies-license.md | 프로젝트 의존 라이브러리의 라이선스 정보 | | MAINTAINERS.md | 프로젝트 관리자를 위한 지침 | | RELEASE-PROCESS.md | 새로운 버전을 릴리스하는 절차 | | SECURITY.md | 보안 정책 및 취약성 보고 방법 | diff --git a/source/did-ta-server/Dockerfile b/source/did-ta-server/Dockerfile index 34a7035..1de19c2 100644 --- a/source/did-ta-server/Dockerfile +++ b/source/did-ta-server/Dockerfile @@ -1,10 +1,7 @@ -# 1. Base image 선택 FROM openjdk:17-jdk-slim -# 2. 작업 디렉토리 설정 WORKDIR /app -# 3. Gradle Wrapper와 필요한 파일 복사 COPY gradlew . COPY gradle gradle COPY libs libs @@ -13,11 +10,8 @@ COPY build.gradle . COPY settings.gradle . COPY src src -# 4. Gradle Wrapper에 실행 권한 부여 RUN chmod +x ./gradlew -# 6. Spring Boot 애플리케이션 빌드 RUN ./gradlew bootJar -# 8. 컨테이너 시작 시 JAR 파일 실행 CMD ["java", "-jar", "/app/build/libs/Tas.jar"] \ No newline at end of file From c48fc705e5c737a32e36b6acdf1cc3014ce7f36f Mon Sep 17 00:00:00 2001 From: gwnam Date: Mon, 28 Oct 2024 18:47:55 +0900 Subject: [PATCH 2/4] chore: add/modify Github Action --- .github/workflows/{build.yaml => build.yml} | 24 ++++++++--------- .github/workflows/ci.yml | 29 +++++++++++++++++++++ 2 files changed, 41 insertions(+), 12 deletions(-) rename .github/workflows/{build.yaml => build.yml} (75%) create mode 100644 .github/workflows/ci.yml diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yml similarity index 75% rename from .github/workflows/build.yaml rename to .github/workflows/build.yml index 5f361e7..153bb7a 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yml @@ -17,7 +17,7 @@ jobs: defaults: run: - working-directory: source/did-tas-server + working-directory: source/did-ta-server steps: - name: Checkout code uses: actions/checkout@v4 @@ -44,42 +44,42 @@ jobs: run: | release_tag=${GITHUB_HEAD_REF#release/QA-} echo "Release tag: $release_tag" - echo "release_tag=$release_tag" >> $GITHUB_ENV # Write to the environment file + echo "::set-output name=release_tag::$release_tag" - name: Get commit messages id: get_commit_messages run: | commits=$(git log ${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }} --pretty=format:"* %s") echo "$commits" > commit_messages.txt - echo "commits=$commits" >> $GITHUB_ENV # Write to the environment file + echo "::set-output name=commits::$commits" - name: Find JAR file id: find_jar run: | jar_path=$(find ./build/libs -name "*.jar" | head -n 1) echo "JAR path found: $jar_path" - echo "jar_path=$jar_path" >> $GITHUB_ENV # Write to the environment file + echo "::set-output name=jar_path::$jar_path" - name: Calculate SHA-256 id: calculate_sha run: | sha256=$(sha256sum ${{ env.jar_path }} | awk '{ print $1 }') echo "SHA-256: $sha256" - echo "jar_sha256=$sha256" >> $GITHUB_ENV # Write to the environment file - + echo "::set-output name=jar_sha256::$sha256" + - name: Create GitHub Release id: create_release uses: actions/create-release@v1 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: - tag_name: ${{ env.release_tag }} - release_name: ${{ env.release_tag }} + tag_name: ${{ steps.set_release_title.outputs.release_tag }} + release_name: ${{ steps.set_release_title.outputs.release_tag }} body: | ## Changes: - ${{ env.commits }} + ${{ steps.get_commit_messages.outputs.commits }} ## Checksum: - SHA-256: ${{ env.jar_sha256 }} + SHA-256: ${{ steps.calculate_sha.outputs.jar_sha256 }} - name: Upload JAR uses: actions/upload-release-asset@v1 @@ -87,6 +87,6 @@ jobs: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: upload_url: ${{ steps.create_release.outputs.upload_url }} - asset_path: source/did-tas-server/${{ env.jar_path }} - asset_name: did-tas-server-${{ env.release_tag }}.jar + asset_path: source/did-ta-server/${{ steps.find_jar.outputs.jar_path }} + asset_name: did-ta-server-${{ steps.set_release_title.outputs.release_tag }}.jar asset_content_type: application/java-archive diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..39474af --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,29 @@ +name: Java CI with Gradle +on: + push: + branches: [ main, develop ] + pull_request: + branches: [ main, develop ] + + +jobs: + build: + runs-on: ubuntu-latest + defaults: + run: + working-directory: source/did-ta-server + permissions: + contents: read + steps: + - uses: actions/checkout@v4 + - name: Set up JDK 17 + uses: actions/setup-java@v4 + with: + java-version: '17' + distribution: 'temurin' + + - name: Test with Gradle Wrapper + run: ./gradlew test + + - name: Build with Gradle Wrapper + run: ./gradlew clean build From 9ab51d30e08f90ccc14869282b863b9745165bd8 Mon Sep 17 00:00:00 2001 From: gw-nam Date: Tue, 29 Oct 2024 11:11:52 +0900 Subject: [PATCH 3/4] docs: Added new "Demo Videos" section to README.md --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7cd09c5..907b774 100644 --- a/README.md +++ b/README.md @@ -105,9 +105,14 @@ For detailed instructions on installing and configuring the TA Server, please re The Change Log provides a detailed record of version-specific changes and updates. You can find it here: - [Change Log](./CHANGELOG.md) +## OpenDID Demonstration Videos
+To watch our demonstration videos of the OpenDID system in action, please visit our [Demo Repository](https://github.com/OmniOneID/did-demo-server).
+ +These videos showcase key features including user registration, VC issuance, and VP submission processes. + ## Contributing Please read [CONTRIBUTING.md](CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for details on our code of conduct, and the process for submitting pull requests to us. ## License -[Apache 2.0](LICENSE) \ No newline at end of file +[Apache 2.0](LICENSE) From 0b6dc4d81e530161aa8cb749e842adb51bca1afb Mon Sep 17 00:00:00 2001 From: yoongyu-lee Date: Wed, 30 Oct 2024 21:19:06 +0900 Subject: [PATCH 4/4] Add Korean README and Fix Typos in Original Document (#8) --- README.md | 53 ++++++++++++----------- README_ko.md | 120 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 147 insertions(+), 26 deletions(-) create mode 100644 README_ko.md diff --git a/README.md b/README.md index 907b774..2fb1d56 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ did-ta-server ├── libs └── did-sdk-common-1.0.0.jar └── did-blockchain-sdk-server-1.0.0.jar - └── did-core-sdk-server-1.0.0..jar + └── did-core-sdk-server-1.0.0.jar └── did-crypto-sdk-server-1.0.0.jar └── did-datamodel-sdk-server-1.0.0.jar └── did-wallet-sdk-server-1.0.0.jar @@ -42,35 +42,36 @@ did-ta-server └── src └── build.gradle └── README.md + └── README_ko.md ```
Below is a description of each folder and file in the directory: -| Name | Description | -| ----------------------- | ----------------------------------------------- | -| CHANGELOG.md | Version-specific changes in the project | -| CODE_OF_CONDUCT.md | Code of conduct for contributors | -| CONTRIBUTING.md | Contribution guidelines and procedures | -| LICENSE | License | -| dependencies-license.md | Licenses for the project’s dependency libraries | -| MAINTAINERS.md | Guidelines for project maintainers | -| RELEASE-PROCESS.md | Procedures for releasing new versions | -| SECURITY.md | Security policies and vulnerability reporting | -| docs | Documentation | -| ┖ api | API guide documentation | -| ┖ errorCode | Error codes and troubleshooting guides | -| ┖ installation | Installation and setup instructions | -| ┖ db | Database ERD, Table Specifications | -| source | Server source code project | -| ┖ did-ta-server | TAS Server source code and build files | -| ┖ gradle | Gradle build configurations and scripts | -| ┖ libs | External libraries and dependencies | -| ┖ sample | Sample files | -| ┖ src | Main source code directory | -| ┖ build.gradle | Gradle build configuration file | -| ┖ README.md | Overview and instructions for the source code | +| Name | Description | +| -------------------------------- | ----------------------------------------------- | +| CHANGELOG.md | Version-specific changes in the project | +| CODE_OF_CONDUCT.md | Code of conduct for contributors | +| CONTRIBUTING.md | Contribution guidelines and procedures | +| LICENSE | License | +| dependencies-license.md | Licenses for the project’s dependency libraries | +| MAINTAINERS.md | Guidelines for project maintainers | +| RELEASE-PROCESS.md | Procedures for releasing new versions | +| SECURITY.md | Security policies and vulnerability reporting | +| docs | Documentation | +| ┖ api | API guide documentation | +| ┖ errorCode | Error codes and troubleshooting guides | +| ┖ installation | Installation and setup instructions | +| ┖ db | Database ERD, Table Specifications | +| source | Server source code project | +| ┖ did-ta-server | TAS Server source code and build files | +|    ┖ gradle | Gradle build configurations and scripts | +|    ┖ libs | External libraries and dependencies | +|    ┖ sample | Sample files | +|    ┖ src | Main source code directory | +|    ┖ build.gradle | Gradle build configuration file | +|    ┖ README.md | Overview and instructions for the source code |
@@ -79,7 +80,7 @@ Below is a description of each folder and file in the directory: Libraries used in this project are organized into two main categories: -1. **Open DID Libraries**: These libraries are developed by the Open DID project and are available in the [libs folder](source/tas/libs). They include: +1. **Open DID Libraries**: These libraries are developed by the Open DID project and are available in the [libs folder](source/did-ta-server/libs). They include: - `did-sdk-common-1.0.0.jar` - `did-blockchain-sdk-server-1.0.0.jar` @@ -88,7 +89,7 @@ Libraries used in this project are organized into two main categories: - `did-datamodel-sdk-server-1.0.0.jar` - `did-wallet-sdk-server-1.0.0.jar` -2. **Third-Party Libraries**: These libraries are open-source dependencies managed via the [build.gradle](source/tas/build.gradle) file. For a detailed list of third-party libraries and their licenses, please refer to the [LICENSE-dependencies.md](LICENSE-dependencies.md) file. +2. **Third-Party Libraries**: These libraries are open-source dependencies managed via the [build.gradle](source/did-ta-server/build.gradle) file. For a detailed list of third-party libraries and their licenses, please refer to the [dependencies-license.md](dependencies-license.md) file. ## Installation And Operation Guide diff --git a/README_ko.md b/README_ko.md new file mode 100644 index 0000000..9235afa --- /dev/null +++ b/README_ko.md @@ -0,0 +1,120 @@ +TAS(Trust Agent Service) Server +== + +TAS 서버 Repository에 오신 것을 환영합니다.
+이 Repository는 TAS 서버의 소스 코드, 문서, 관련 리소스를 포함하고 있습니다. + +## 폴더 구조 +프로젝트 디렉터리 내 주요 폴더와 문서에 대한 개요: + +``` +did-ta-server +├── CHANGELOG.md +├── CLA.md +├── CODE_OF_CONDUCT.md +├── CONTRIBUTING.md +├── LICENSE +├── dependencies-license.md +├── MAINTAINERS.md +├── README.md +├── RELEASE-PROCESS.md +├── SECURITY.md +├── docs +│   └── api +│   └── TAS_API_ko.md +│   └── errorCode +│   └── TAS_ErrorCode.md +│   └── installation +│   └── OpenDID_TASServer_InstallationAndOperation_Guide.md +│   └── db +│   └── OpenDID_TableDefinition_TAS.md +└── source + └── did-ta-server + ├── gradle + ├── libs + └── did-sdk-common-1.0.0.jar + └── did-blockchain-sdk-server-1.0.0.jar + └── did-core-sdk-server-1.0.0..jar + └── did-crypto-sdk-server-1.0.0.jar + └── did-datamodel-sdk-server-1.0.0.jar + └── did-wallet-sdk-server-1.0.0.jar + ├── sample + └── src + └── build.gradle + └── README.md + └── README_ko.md +``` + +
+ +각 폴더와 파일에 대한 설명은 다음과 같습니다: + +| 이름 | 설명 | +| -------------------------------- | ---------------------------------------- | +| CHANGELOG.md | 프로젝트의 버전별 변경 사항 | +| CODE_OF_CONDUCT.md | 기여자 행동 강령 | +| CONTRIBUTING.md | 기여 지침과 절차 | +| LICENSE | 라이선스 | +| dependencies-license.md | 프로젝트 의존 라이브러리의 라이선스 정보 | +| MAINTAINERS.md | 프로젝트 유지 관리자 지침 | +| RELEASE-PROCESS.md | 새 버전 릴리스 절차 | +| SECURITY.md | 보안 정책 및 취약성 보고 방법 | +| docs | 문서화 | +| ┖ api | API 가이드 문서 | +| ┖ errorCode | 오류 코드 및 문제 해결 가이드 | +| ┖ installation | 설치 및 설정 지침 | +| ┖ db | 데이터베이스 ERD, 테이블 명세서 | +| source | 서버 소스 코드 프로젝트 | +| ┖ did-ta-server | TAS 서버 소스 코드 및 빌드 파일 | +|    ┖ gradle | Gradle 빌드 설정 및 스크립트 | +|    ┖ libs | 외부 라이브러리 및 종속성 | +|    ┖ sample | 샘플 파일 | +|    ┖ src | 주요 소스 코드 디렉터리 | +|    ┖ build.gradle | Gradle 빌드 설정 파일 | +|    ┖ README.md | 소스 코드 개요 및 지침 | + +
+ + +## 라이브러리 + +이 프로젝트에서 사용되는 라이브러리는 두 가지 주요 카테고리로 구성됩니다: + +1. **Open DID 라이브러리**: Open DID 프로젝트에서 개발된 라이브러리로, [libs 폴더](source/did-ta-server/libs)에 포함되어 있습니다. 주요 라이브러리는 다음과 같습니다: + + - `did-sdk-common-1.0.0.jar` + - `did-blockchain-sdk-server-1.0.0.jar` + - `did-core-sdk-server-1.0.0.jar` + - `did-crypto-sdk-server-1.0.0.jar` + - `did-datamodel-sdk-server-1.0.0.jar` + - `did-wallet-sdk-server-1.0.0.jar` + +2. **서드 파티 라이브러리**: 이 라이브러리들은 오픈 소스 종속성으로, [build.gradle](source/did-ta-server/build.gradle) 파일을 통해 관리됩니다. 서드 파티 라이브러리와 해당 라이선스의 자세한 목록은 [dependencies-license.md](dependencies-license.md) 파일을 참고하십시오. + +## 설치 및 운영 가이드 + +TA 서버의 설치 및 구성에 대한 자세한 지침은 아래 가이드를 참조하십시오: +- [OpenDID TAS 서버 설치 및 운영 가이드](docs/installation/OpenDID_TASServer_InstallationAndOperation_Guide.md) + +## API 참고 문서 + +- **TAS API**: TAS 서버의 API 엔드포인트 및 사용법에 대한 자세한 참고 자료입니다. + - [TAS API 참고 자료](docs/api/TAS_API_ko.md) + +## Change Log + +Change Log에는 버전별 변경 사항과 업데이트가 자세히 기록되어 있습니다. 다음에서 확인할 수 있습니다: +- [Change Log](./CHANGELOG.md) + +## OpenDID 시연 영상 + +OpenDID 시스템의 시연 영상을 보려면 [데모 Repository](https://github.com/OmniOneID/did-demo-server)를 방문하십시오.
+ +이 영상에서는 사용자 등록, VC 발급, VP 제출 프로세스 등 주요 기능을 시연합니다. + +## 기여 + +기여 절차와 행동 강령에 대한 자세한 내용은 [CONTRIBUTING.md](CONTRIBUTING.md)와 [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)를 참조해 주십시오. + +## 라이선스 +[Apache 2.0](LICENSE)