Skip to content

Latest commit

 

History

History
150 lines (118 loc) · 5.7 KB

README_zh.md

File metadata and controls

150 lines (118 loc) · 5.7 KB
Raw

GitHub Action for workflow cron

README | 中文文档

用于使用 GitHub 令牌授权推送到 GitHub 存储库更改工作流cron的 GitHub 操作。

使用场景:

  • 用于GitHub actions工作流无规律调度运行
  • 自动生成随机cron表达式, 只针对hour和minute随机生成

用法

示例工作流文件

将当前分支工作流文件中的schedule下的cron表达式进行随机修改(自己修改自己)，并且保留除工作流文件外的文件历史提交描述：

name: 'random-cron'

on:
  schedule:
    - cron: '0 0 */17 * *'
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Random Cron
        uses: grbnb/random-workflow-cron@v2
        with:
          github_token: ${{ secrets.PAT }}
          keep_history: true

将当前仓库中的其它分支dev工作流文件ci.yml中的schedule下的cron进行随机修改(修改其它文件)[不建议]，并且保留除工作流文件外的文件历史提交描述：

name: 'random-cron'

on:
  schedule:
    - cron: '0 0 */17 * *'
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Random Cron
        uses: grbnb/random-workflow-cron@v2
        with:
          workflow_name: ".github/workflows/ci.yml"
          github_token: ${{ secrets.PAT }}
          ref_branch: dev
          keep_history: true

设置随机小时范围为1-21[UTC+8时区]，每间隔15天并且一天只运行7次， 但是不立即推送提交到仓库，即工作流文件后面的步骤存在推送操作，避免多次推送！！！

name: 'random-cron'

on:
  schedule:
    - cron: '0 0 */17 * *'
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          token: ${{ secrets.PAT }}
          fetch-depth: 2
      
      - name: Random Cron
        uses: grbnb/random-workflow-cron@v1
        with:
          push_switch: false
          time_zone: "UTC+8"
          hour_start: 1
          hour_end: 21
          interval_count: 7
          cron_dmw: "*/15 * *"

自定义变量

变量名 变量值类型 默认值 描述
workflow_name string ${{ github.workflow_ref }} 修改的工作流文件名路径
默认为当前工作流路径
例如：.github/workflow/cron.yml
push_switch boolean true 修改后的工作流文件是否立即推送
github_token string ${{ github.token }} 至少具有repo和workflow权限的GitHub PAT 密钥 Personal Access Token.
repository string ${{ github.repository }} 存储库名称.
默认为当前github存储库
如果您想推送到其他存储库,
你应该创建一个personal access token
并将其用作github_token输入
ref_branch string ${{ github.ref_name }} 修改后的工作流文件推送的目标分支
keep_history boolean false 保留除workflow_file文件外的历史记录提交描述
author string github-actions[bot] <github-actions[bot]@users.noreply.github.com> 作者姓名和电子邮件地址作为显示名称 <[email protected]>(默认为GitHub Actions机器人程序用户)
time_zone string UTC+0 用户所在区域的时区，范围UTC±12, 自动向下取整 例如：UTC+3.5 => UTC+3
hour_start number 0 定义区间开始时间
hour_end number 23 定义区间结束时间
interval_count number 2 将一天划分的间隔数,即一天运行的次数
cron_dmw string "* * *" 自定义 Cron 日期 月份 星期

遇到问题

 ! [remote rejected] dev -> dev (refusing to allow a GitHub App to create or update workflow `.github/workflows/xxxx.yml` without `workflows` permission)
error: failed to push some refs to 'https://github.com/xxx/xxxx.git'
Error: Process completed with exit code 1.

由于涉及到修改workflow文件的修改和推送，默认的GITHUB_TOKEN没有相应权限，请务必前往settings -> Secrets and variables -> New repository secret添加个人私钥

name: PAT
secret: ghp_XXXXXXXXXX

如果没有，创建方法如下：

  • 点击右侧图标PAT ，设置token密钥
  • 在Note处填入一个名称 -> 在Expiration处选择一个有效期 -> 在Select scopes处依次勾选repo、workflow、write:packages和delete:packages -> 点击最下方Generate token

Personal Access Token

remote: Permission to xxx/xxxxx.git denied to github-actions[bot].
fatal: unable to access 'https://github.com/xxx/xxxxx.git/': The requested URL returned error: 403
Error: Invalid exit code: 128

添加GitHub API token密钥到工作流yml文件的uses:actions/checkout@v3步骤中

- name: Checkout
  uses: actions/checkout@v4
  with:
    token: ${{ secrets.PAT }}
    fetch-depth: 2

然后将生成的PAT密钥添加到存储库的Actions secrets and variables中

许可证

本项目中的Dockerfile及相关脚本和文档是根据MIT许可证发布的。

与GitHub股份有限公司无关联

GitHub是GitHub，Inc.的注册商标。本项目中使用的GitHup名称仅用于识别目的。该项目与GitHub股份有限公司没有任何关联，也不是GitHup股份有限公司的官方解决方案。提供该项目是为了方便使用GitHub网站。