From adcb5025dd3bfd08fe6a53d7e16a6b61b882be9c Mon Sep 17 00:00:00 2001 From: ck_yeun9 Date: Tue, 4 Mar 2025 05:15:22 +0000 Subject: [PATCH 1/3] add default pipeline template yaml --- .workflow/branch-pipeline.yml | 53 +++++++++++++++++++++++++++++++++++ .workflow/master-pipeline.yml | 51 +++++++++++++++++++++++++++++++++ .workflow/pr-pipeline.yml | 40 ++++++++++++++++++++++++++ 3 files changed, 144 insertions(+) create mode 100644 .workflow/branch-pipeline.yml create mode 100644 .workflow/master-pipeline.yml create mode 100644 .workflow/pr-pipeline.yml diff --git a/.workflow/branch-pipeline.yml b/.workflow/branch-pipeline.yml new file mode 100644 index 0000000..9d2a292 --- /dev/null +++ b/.workflow/branch-pipeline.yml @@ -0,0 +1,53 @@ +version: '1.0' +name: branch-pipeline +displayName: BranchPipeline +stages: + - stage: + name: compile + displayName: 编译 + steps: + - step: build@maven + name: build_maven + displayName: Maven 构建 + # 支持6、7、8、9、10、11六个版本 + jdkVersion: 8 + # 支持2.2.1、3.2.5、3.3.9、3.5.2、3.5.3、3.5.4、3.6.1、3.6.3八个版本 + mavenVersion: 3.3.9 + # 构建命令 + commands: + - mvn -B clean package -Dmaven.test.skip=true + # 非必填字段，开启后表示将构建产物暂存，但不会上传到制品库中，7天后自动清除 + artifacts: + # 构建产物名字，作为产物的唯一标识可向下传递，支持自定义，默认为BUILD_ARTIFACT。在下游可以通过${BUILD_ARTIFACT}方式引用来获取构建物地址 + - name: BUILD_ARTIFACT + # 构建产物获取路径，是指代码编译完毕之后构建物的所在路径，如通常jar包在target目录下。当前目录为代码库根目录 + path: + - ./target + - step: publish@general_artifacts + name: publish_general_artifacts + displayName: 上传制品 + # 上游构建任务定义的产物名，默认BUILD_ARTIFACT + dependArtifact: BUILD_ARTIFACT + # 上传到制品库时的制品命名，默认output + artifactName: output + dependsOn: build_maven + - stage: + name: release + displayName: 发布 + steps: + - step: publish@release_artifacts + name: publish_release_artifacts + displayName: '发布' + # 上游上传制品任务的产出 + dependArtifact: output + # 发布制品版本号 + version: '1.0.0.0' + # 是否开启版本号自增，默认开启 + autoIncrement: true +triggers: + push: + branches: + exclude: + - master + include: + - .* diff --git a/.workflow/master-pipeline.yml b/.workflow/master-pipeline.yml new file mode 100644 index 0000000..5d926c2 --- /dev/null +++ b/.workflow/master-pipeline.yml @@ -0,0 +1,51 @@ +version: '1.0' +name: master-pipeline +displayName: MasterPipeline +stages: + - stage: + name: compile + displayName: 编译 + steps: + - step: build@maven + name: build_maven + displayName: Maven 构建 + # 支持6、7、8、9、10、11六个版本 + jdkVersion: 8 + # 支持2.2.1、3.2.5、3.3.9、3.5.2、3.5.3、3.5.4、3.6.1、3.6.3八个版本 + mavenVersion: 3.3.9 + # 构建命令 + commands: + - mvn -B clean package -Dmaven.test.skip=true + # 非必填字段，开启后表示将构建产物暂存，但不会上传到制品库中，7天后自动清除 + artifacts: + # 构建产物名字，作为产物的唯一标识可向下传递，支持自定义，默认为BUILD_ARTIFACT。在下游可以通过${BUILD_ARTIFACT}方式引用来获取构建物地址 + - name: BUILD_ARTIFACT + # 构建产物获取路径，是指代码编译完毕之后构建物的所在路径，如通常jar包在target目录下。当前目录为代码库根目录 + path: + - ./target + - step: publish@general_artifacts + name: publish_general_artifacts + displayName: 上传制品 + # 上游构建任务定义的产物名，默认BUILD_ARTIFACT + dependArtifact: BUILD_ARTIFACT + # 上传到制品库时的制品命名，默认output + artifactName: output + dependsOn: build_maven + - stage: + name: release + displayName: 发布 + steps: + - step: publish@release_artifacts + name: publish_release_artifacts + displayName: '发布' + # 上游上传制品任务的产出 + dependArtifact: output + # 发布制品版本号 + version: '1.0.0.0' + # 是否开启版本号自增，默认开启 + autoIncrement: true +triggers: + push: + branches: + include: + - master diff --git a/.workflow/pr-pipeline.yml b/.workflow/pr-pipeline.yml new file mode 100644 index 0000000..3f7579d --- /dev/null +++ b/.workflow/pr-pipeline.yml @@ -0,0 +1,40 @@ +version: '1.0' +name: pr-pipeline +displayName: PRPipeline +stages: + - stage: + name: compile + displayName: 编译 + steps: + - step: build@maven + name: build_maven + displayName: Maven 构建 + # 支持6、7、8、9、10、11六个版本 + jdkVersion: 8 + # 支持2.2.1、3.2.5、3.3.9、3.5.2、3.5.3、3.5.4、3.6.1、3.6.3八个版本 + mavenVersion: 3.3.9 + # 构建命令 + commands: + - mvn -B clean package -Dmaven.test.skip=true + # 非必填字段，开启后表示将构建产物暂存，但不会上传到制品库中，7天后自动清除 + artifacts: + # 构建产物名字，作为产物的唯一标识可向下传递，支持自定义，默认为BUILD_ARTIFACT。在下游可以通过${BUILD_ARTIFACT}方式引用来获取构建物地址 + - name: BUILD_ARTIFACT + # 构建产物获取路径，是指代码编译完毕之后构建物的所在路径，如通常jar包在target目录下。当前目录为代码库根目录 + path: + - ./target + - step: publish@general_artifacts + name: publish_general_artifacts + displayName: 上传制品 + # 上游构建任务定义的产物名，默认BUILD_ARTIFACT + dependArtifact: BUILD_ARTIFACT + # 构建产物制品库，默认default，系统默认创建 + artifactRepository: default + # 上传到制品库时的制品命名，默认output + artifactName: output + dependsOn: build_maven +triggers: + pr: + branches: + include: + - master -- Gitee From 7468282bd8f9796b25eb72894721545b4453de01 Mon Sep 17 00:00:00 2001 From: ck_yeun9 Date: Tue, 4 Mar 2025 05:58:50 +0000 Subject: [PATCH 2/3] =?UTF-8?q?=E5=88=A0=E9=99=A4=E6=96=87=E4=BB=B6=20.wor?= =?UTF-8?q?kflow?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .workflow/branch-pipeline.yml | 53 ----------------------------------- .workflow/master-pipeline.yml | 51 --------------------------------- .workflow/pr-pipeline.yml | 40 -------------------------- 3 files changed, 144 deletions(-) delete mode 100644 .workflow/branch-pipeline.yml delete mode 100644 .workflow/master-pipeline.yml delete mode 100644 .workflow/pr-pipeline.yml diff --git a/.workflow/branch-pipeline.yml b/.workflow/branch-pipeline.yml deleted file mode 100644 index 9d2a292..0000000 --- a/.workflow/branch-pipeline.yml +++ /dev/null @@ -1,53 +0,0 @@ -version: '1.0' -name: branch-pipeline -displayName: BranchPipeline -stages: - - stage: - name: compile - displayName: 编译 - steps: - - step: build@maven - name: build_maven - displayName: Maven 构建 - # 支持6、7、8、9、10、11六个版本 - jdkVersion: 8 - # 支持2.2.1、3.2.5、3.3.9、3.5.2、3.5.3、3.5.4、3.6.1、3.6.3八个版本 - mavenVersion: 3.3.9 - # 构建命令 - commands: - - mvn -B clean package -Dmaven.test.skip=true - # 非必填字段，开启后表示将构建产物暂存，但不会上传到制品库中，7天后自动清除 - artifacts: - # 构建产物名字，作为产物的唯一标识可向下传递，支持自定义，默认为BUILD_ARTIFACT。在下游可以通过${BUILD_ARTIFACT}方式引用来获取构建物地址 - - name: BUILD_ARTIFACT - # 构建产物获取路径，是指代码编译完毕之后构建物的所在路径，如通常jar包在target目录下。当前目录为代码库根目录 - path: - - ./target - - step: publish@general_artifacts - name: publish_general_artifacts - displayName: 上传制品 - # 上游构建任务定义的产物名，默认BUILD_ARTIFACT - dependArtifact: BUILD_ARTIFACT - # 上传到制品库时的制品命名，默认output - artifactName: output - dependsOn: build_maven - - stage: - name: release - displayName: 发布 - steps: - - step: publish@release_artifacts - name: publish_release_artifacts - displayName: '发布' - # 上游上传制品任务的产出 - dependArtifact: output - # 发布制品版本号 - version: '1.0.0.0' - # 是否开启版本号自增，默认开启 - autoIncrement: true -triggers: - push: - branches: - exclude: - - master - include: - - .* diff --git a/.workflow/master-pipeline.yml b/.workflow/master-pipeline.yml deleted file mode 100644 index 5d926c2..0000000 --- a/.workflow/master-pipeline.yml +++ /dev/null @@ -1,51 +0,0 @@ -version: '1.0' -name: master-pipeline -displayName: MasterPipeline -stages: - - stage: - name: compile - displayName: 编译 - steps: - - step: build@maven - name: build_maven - displayName: Maven 构建 - # 支持6、7、8、9、10、11六个版本 - jdkVersion: 8 - # 支持2.2.1、3.2.5、3.3.9、3.5.2、3.5.3、3.5.4、3.6.1、3.6.3八个版本 - mavenVersion: 3.3.9 - # 构建命令 - commands: - - mvn -B clean package -Dmaven.test.skip=true - # 非必填字段，开启后表示将构建产物暂存，但不会上传到制品库中，7天后自动清除 - artifacts: - # 构建产物名字，作为产物的唯一标识可向下传递，支持自定义，默认为BUILD_ARTIFACT。在下游可以通过${BUILD_ARTIFACT}方式引用来获取构建物地址 - - name: BUILD_ARTIFACT - # 构建产物获取路径，是指代码编译完毕之后构建物的所在路径，如通常jar包在target目录下。当前目录为代码库根目录 - path: - - ./target - - step: publish@general_artifacts - name: publish_general_artifacts - displayName: 上传制品 - # 上游构建任务定义的产物名，默认BUILD_ARTIFACT - dependArtifact: BUILD_ARTIFACT - # 上传到制品库时的制品命名，默认output - artifactName: output - dependsOn: build_maven - - stage: - name: release - displayName: 发布 - steps: - - step: publish@release_artifacts - name: publish_release_artifacts - displayName: '发布' - # 上游上传制品任务的产出 - dependArtifact: output - # 发布制品版本号 - version: '1.0.0.0' - # 是否开启版本号自增，默认开启 - autoIncrement: true -triggers: - push: - branches: - include: - - master diff --git a/.workflow/pr-pipeline.yml b/.workflow/pr-pipeline.yml deleted file mode 100644 index 3f7579d..0000000 --- a/.workflow/pr-pipeline.yml +++ /dev/null @@ -1,40 +0,0 @@ -version: '1.0' -name: pr-pipeline -displayName: PRPipeline -stages: - - stage: - name: compile - displayName: 编译 - steps: - - step: build@maven - name: build_maven - displayName: Maven 构建 - # 支持6、7、8、9、10、11六个版本 - jdkVersion: 8 - # 支持2.2.1、3.2.5、3.3.9、3.5.2、3.5.3、3.5.4、3.6.1、3.6.3八个版本 - mavenVersion: 3.3.9 - # 构建命令 - commands: - - mvn -B clean package -Dmaven.test.skip=true - # 非必填字段，开启后表示将构建产物暂存，但不会上传到制品库中，7天后自动清除 - artifacts: - # 构建产物名字，作为产物的唯一标识可向下传递，支持自定义，默认为BUILD_ARTIFACT。在下游可以通过${BUILD_ARTIFACT}方式引用来获取构建物地址 - - name: BUILD_ARTIFACT - # 构建产物获取路径，是指代码编译完毕之后构建物的所在路径，如通常jar包在target目录下。当前目录为代码库根目录 - path: - - ./target - - step: publish@general_artifacts - name: publish_general_artifacts - displayName: 上传制品 - # 上游构建任务定义的产物名，默认BUILD_ARTIFACT - dependArtifact: BUILD_ARTIFACT - # 构建产物制品库，默认default，系统默认创建 - artifactRepository: default - # 上传到制品库时的制品命名，默认output - artifactName: output - dependsOn: build_maven -triggers: - pr: - branches: - include: - - master -- Gitee From 44c4893cd6d1780a7d7ad4428833f9f11b55a41c Mon Sep 17 00:00:00 2001 From: ck_yeun9 Date: Thu, 8 May 2025 10:18:13 +0000 Subject: [PATCH 3/3] update README.md. Signed-off-by: ck_yeun9 --- README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/README.md b/README.md index 24c51dc..c59d87c 100644 --- a/README.md +++ b/README.md @@ -142,6 +142,60 @@ EOM.TSHotelManagement.Web **下载并安装Microsoft Visual Studio Professional 2022及以上版本，并通过下载Zip包解压，打开.sln后缀格式文件运行。** +### :inbox_tray: Docker运行部署(以Ubuntu为例)： + +``` +docker run -d \ + --name tshotel-api \ + -v /app/config:/app/config \ + -v /app/keys:/app/keys \ + -e DefaultDatabase=MariaDB \ + -e ASPNETCORE_ENVIRONMENT=docker \ + -e DOCKER_ENV=true \ + -e "MariaDBConnectStr=Server=host;User=tshoteldb;Password=password;Database=tshoteldb" \ + -e Jwt__Issuer=Easy-Open-Meta \ + -e Jwt__Audience=EOM.TSHotelManagement.WebApi \ + -e Jwt__Key=Easy-Open-Meta-EfH@u4poHh544a53Sq77T \ + -e Jwt__ExpiryMinutes=20 \ + -e Lsky__BaseAddress=https://lsky.demo.top/api/v1 \ + -e Lsky__Email=demo@demo.top \ + -e Lsky__Password=demo \ + -e Lsky__UploadApi=/upload \ + -e Lsky__GetTokenApi=/tokens \ + -e Mail__Host=smtp.demo.top \ + -e Mail__UserName=demo@demo.top \ + -e Mail__Password=demo \ + -e Mail__Port=465 \ + -e Mail__EnableSsl=true \ + -e Mail__DisplayName=TSHotel-Administrator \ + -p 63001:8080 \ + yjj6731/tshotel-management-system-api:latest +``` + +| 参数名称 | 参数说明 | 必填(Y/N) | 默认值 | 可选值 | +|------|------|---------|-----|-----| +|name|容器名称|Y|N/A|N/A| +|DefaultDatabase|默认数据库|Y|N/A|MariaDB/MySql/SqlServer/PgSql| +|ASPNETCORE_ENVIRONMENT|系统环境(决定Dataprotection Key的生成位置)|Y|docker|docker| +|DOCKER_ENV|是否为docker环境|Y|true|true| +|{默认数据库(e.g:MariaDB/MySql/SqlServer/PgSql)}ConnectStr|对应数据库链接字符串|Y|N/A|N/A| +|Jwt__Issuer|签发者标识|Y|N/A|N/A| +|Jwt__Audience|目标接收方标识|Y|N/A|N/A| +|Jwt__Key|JWT Key|Y|N/A|N/A| +|Jwt__ExpiryMinutes|token有效时间/分钟|Y|20|N/A| +|Lsky__BaseAddress|兰空图床基础地址|Y|N/A|N/A| +|Lsky__Email|兰空图床账户邮箱|Y|N/A|N/A| +|Lsky__Password|兰空图床账户密码|Y|N/A|N/A| +|Lsky__UploadApi|兰空图床上传图片接口|Y|N/A|N/A| +|Lsky__GetTokenApi|兰空图床获取tokens接口|Y|N/A|N/A| +|Mail__Host|邮箱smtp协议地址|Y|N/A|N/A| +|Mail__UserName|邮箱smtp协议地址|Y|N/A|N/A| +|Mail__Port|邮箱smtp端口|Y|465|N/A| +|Mail__Password|邮箱密码|Y|N/A|N/A| +|Mail__EnableSsl|是否启用SSL|Y|true|true/false| +|Mail__DisplayName|发送邮件人显示名称|Y|N/A|N/A| + + ### :inbox_tray: 数据库运行部署(本地)： **作者及开发团队强烈建议使用MariaDB数据库，安装MariaDB数据库并开启服务，通过可视化管理工具对数据库进行建立，可通过打开执行数据库脚本文件夹内的.sql后缀格式文件进行快速建立数据表和导入数据，执行步骤(以MariaDB数据库为例)：** -- Gitee