From 201039a1c5b513de5f027b588002c8803c294b55 Mon Sep 17 00:00:00 2001 From: shencangsheng Date: Tue, 26 Apr 2022 18:14:27 +0800 Subject: [PATCH] docs: change readme --- .github/workflows/workflow.yml | 4 ++-- README.md | 11 ++++++++--- i18n/README.zh-cn.md | 21 +++++++++++++-------- 3 files changed, 23 insertions(+), 13 deletions(-) diff --git a/.github/workflows/workflow.yml b/.github/workflows/workflow.yml index b867911..0e74dae 100644 --- a/.github/workflows/workflow.yml +++ b/.github/workflows/workflow.yml @@ -1,7 +1,7 @@ on: push: tags: - - v* + - "[0-9]+.*" jobs: build: runs-on: ubuntu-latest @@ -72,4 +72,4 @@ jobs: context: . push: true tags: ${{ steps.meta.outputs.tags }} - labels: ${{ steps.meta.outputs.labels }} \ No newline at end of file + labels: ${{ steps.meta.outputs.labels }} diff --git a/README.md b/README.md index 86c6195..457cc86 100644 --- a/README.md +++ b/README.md @@ -14,10 +14,12 @@ Tools for generating Git ChangeLogs, including generating and pushing Release wo - [License](#license) ## How to use for your + ### GitLab CI/CD Push Release The login-action options required by GitLab Release include: -* PRIVATE-TOKEN：This is the access token for your GitLab repository. We need to store the GitLab access tokens in the project's CI/CD variable, named `ACCESS_TOKEN`, so that they are not exposed in the workflow file, see [Creating and Using GitLab Access Tokens](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html) for more information + +- PRIVATE-TOKEN：This is the access token for your GitLab repository. We need to store the GitLab access tokens in the project's CI/CD variable, named `ACCESS_TOKEN`, so that they are not exposed in the workflow file, see [Creating and Using GitLab Access Tokens](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html) for more information ```yml release: @@ -34,11 +36,12 @@ release: ``` ### GitHub Action Push Release + ```yml on: push: tags: - - v* + - "[0-9]+.*" jobs: build: runs-on: ubuntu-latest @@ -77,11 +80,13 @@ jobs: ``` ## Credits + This project is incubated by the [shencangsheng/GitLab-Release-Workflow](https://github.com/shencangsheng/GitLab-Release-Workflow) available in the GitHub project. This project was inspired by the [zitsen/release-workflow-demo](https://github.com/zitsen/release-workflow-demo) available in the GitHub project. ## License + A short snippet describing the license (MIT) -MIT © Cangsheng Shen \ No newline at end of file +MIT © Cangsheng Shen diff --git a/i18n/README.zh-cn.md b/i18n/README.zh-cn.md index 133dde8..4986b30 100644 --- a/i18n/README.zh-cn.md +++ b/i18n/README.zh-cn.md @@ -2,22 +2,24 @@ [English](https://github.com/shencangsheng/Git-Release-Workflow) | 简体中文 -生成Git ChangeLog的工具，包含在GitLab CI/CD中生成并推送Release工作流以及GitHub Action的推送Release工作流 +生成 Git ChangeLog 的工具，包含在 GitLab CI/CD 中生成并推送 Release 工作流以及 GitHub Action 的推送 Release 工作流 [DockerHub Repositorie](https://hub.docker.com/r/shencangsheng/gitlab-pipeline-release) - [Git Release Workflow](#git-release-workflow) - [尝试使用](#尝试使用) - - [GitLab CI/CD 推送Release](#gitlab-cicd-推送release) - - [GitHub Action 推送Release](#github-action-推送release) + - [GitLab CI/CD 推送 Release](#gitlab-cicd-推送-release) + - [GitHub Action 推送 Release](#github-action-推送-release) - [Credits](#credits) - [License](#license) ## 尝试使用 -### GitLab CI/CD 推送Release + +### GitLab CI/CD 推送 Release GitLab Release 需要的 login-action 选项包括： -* PRIVATE-TOKEN：这是您的 GitLab 仓库的访问令牌。 我们需要将 GitLab 访问令牌存储在项目的CI/CD变量，命名为`ACCESS_TOKEN`，使它们不会公开在工作流程文件中， 更多信息请参阅[创建和使用GitLab访问令牌](https://docs.gitlab.cn/jh/user/profile/personal_access_tokens.html)。 + +- PRIVATE-TOKEN：这是您的 GitLab 仓库的访问令牌。 我们需要将 GitLab 访问令牌存储在项目的 CI/CD 变量，命名为`ACCESS_TOKEN`，使它们不会公开在工作流程文件中， 更多信息请参阅[创建和使用 GitLab 访问令牌](https://docs.gitlab.cn/jh/user/profile/personal_access_tokens.html)。 ```yml release: @@ -33,12 +35,13 @@ release: - post-gitlab-release-14x ``` -### GitHub Action 推送Release +### GitHub Action 推送 Release + ```yml on: push: tags: - - v* + - "[0-9]+.*" jobs: build: runs-on: ubuntu-latest @@ -77,11 +80,13 @@ jobs: ``` ## Credits + This project is incubated by the [shencangsheng/GitLab-Release-Workflow](https://github.com/shencangsheng/GitLab-Release-Workflow) available in the GitHub project. This project was inspired by the [zitsen/release-workflow-demo](https://github.com/zitsen/release-workflow-demo) available in the GitHub project. ## License + A short snippet describing the license (MIT) -MIT © Cangsheng Shen \ No newline at end of file +MIT © Cangsheng Shen