github中action作用和讲解

2024-09-04 13:04
文章标签 作用 讲解 action github

本文主要是介绍github中action作用和讲解,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

1,简介

GitHub Actions 是 GitHub 的一个自动化功能,它允许你在 GitHub 仓库中自动执行软件开发工作流程。你可以使用 GitHub Actions 来执行各种任务,比如:

  1. 自动测试:每当代码被推送到仓库时,自动运行测试来确保代码质量。
  2. 持续集成:自动构建和部署代码,确保新的代码更改不会破坏现有功能。
  3. 代码格式化:自动格式化代码,以保持代码风格的一致性。
  4. 自动部署:将代码部署到服务器或云平台。
  5. 自动化发布:自动创建版本发布和更新软件包。
  6. 监控:监控应用程序和基础设施,以确保它们正常运行。
  7. 自动化工作流:创建复杂的工作流,以自动化多个步骤和任务。

GitHub Actions 通过定义在 .github/workflows 目录中的 YAML 文件来配置。这些工作流可以触发于各种事件,如推送、拉取请求、定时任务等。你可以使用 GitHub 提供的预设操作(actions),也可以创建自己的自定义操作。

2,如何使用action

使用 GitHub Actions 来自动化你的工作流程涉及几个步骤,下面是基本的流程:

  1. 创建工作流文件

    • 在你的 GitHub 仓库中,找到或创建一个名为 .github/workflows 的目录。
    • 在这个目录下,创建一个新的 YAML 文件来定义你的工作流。文件名可以是任意的,但必须以 .yml 或 .yaml 结尾。
  2. 定义工作流内容

    • 工作流文件的基本结构包括触发器(on)、作业(jobs)和步骤(steps)。
    • 触发器定义了何时运行工作流,例如,当代码被推送到仓库时。
    • 作业是工作流中的一个执行单元,它可以包含多个步骤。
    • 步骤是作业中的单个任务,比如运行脚本或使用操作(action)。
  3. 使用操作(Actions)

    • 操作是 GitHub Actions 的核心,它们是可重用的代码片段,用于执行特定的任务。
    • 你可以使用社区提供的现成操作,或者创建自己的操作。
    • 在步骤中,通过 uses 关键字指定要运行的操作。
  4. 配置工作流

    • 你可以配置工作流以使用不同的环境变量、设置权限、使用不同的运行器(如不同的操作系统或硬件配置)等。
  5. 运行工作流

    • 一旦你推送了工作流文件到仓库,工作流就会根据你定义的触发器自动运行。
    • 你可以在 GitHub 仓库的 "Actions" 标签页中查看工作流的运行状态和历史。
  6. 调试和修改

    • 如果工作流运行失败,你可以查看日志来调试问题。
    • 根据需要调整工作流文件,然后再次推送以测试更改

下面是一个简单的 GitHub Actions 工作流示例,它在每次推送到 main 分支时运行一个简单的 Node.js 脚本:

name: Node.js CI

on: [push]

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3
    - name: Use Node.js
      uses: actions/setup-node@v3
      with:
        node-version: '14'
    - run: npm ci
    - run: npm run build

在这个例子中:

  • name 定义了工作流的名称。
  • on 指定了触发工作流的事件,这里是 push 事件。
  • jobs.build 定义了一个名为 build 的作业。
  • runs-on 指定了运行作业的虚拟机环境。
  • steps 定义了作业中的步骤,包括检出代码、设置 Node.js 环境、安装依赖和构建项目。

3, 实例

以下是一个编译Android13的工作流:

name: Build Kernel - Android 13
on:
  push:
    branches: ["main", "ci", "checkci"]
    paths:
      - ".github/workflows/build-kernel-a13.yml"
      - ".github/workflows/gki-kernel.yml"
      - ".github/scripts/build_a13.sh"
      - "kernel/**"
  pull_request:
    branches: ["main"]
    paths:
      - ".github/workflows/build-kernel-a13.yml"
      - ".github/workflows/gki-kernel.yml"
      - ".github/scripts/build-a13.sh"
      - "kernel/**"
  workflow_call:
jobs:
  build-kernel:
    if: github.event_name != 'pull_request' && github.ref != 'refs/heads/checkci'
    strategy:
      matrix:
        include:
          - version: "5.10"
            sub_level: 189
            os_patch_level: 2023-11
          - version: "5.10"
            sub_level: 198
            os_patch_level: 2024-01
          - version: "5.10"
            sub_level: 205
            os_patch_level: 2024-03
          - version: "5.10"
            sub_level: 209
            os_patch_level: 2024-05
          - version: "5.10"
            sub_level: 210
            os_patch_level: 2024-06
          - version: "5.10"
            sub_level: 214
            os_patch_level: 2024-07
          - version: "5.10"
            sub_level: 218
            os_patch_level: 2024-08
          - version: "5.15"
            sub_level: 123
            os_patch_level: 2023-11
          - version: "5.15"
            sub_level: 137
            os_patch_level: 2024-01
          - version: "5.15"
            sub_level: 144
            os_patch_level: 2024-03
          - version: "5.15"
            sub_level: 148
            os_patch_level: 2024-05
          - version: "5.15"
            sub_level: 149
            os_patch_level: 2024-07
          - version: "5.15"
            sub_level: 151
            os_patch_level: 2024-08
    uses: ./.github/workflows/gki-kernel.yml
    secrets: inherit
    with:
      version: android13-${{ matrix.version }}
      version_name: android13-${{ matrix.version }}.${{ matrix.sub_level }}
      tag: android13-${{ matrix.version }}-${{ matrix.os_patch_level }}
      os_patch_level: ${{ matrix.os_patch_level }}
      patch_path: ${{ matrix.version }}
  
  upload-artifacts:
    needs: build-kernel
    runs-on: ubuntu-latest
    if: ${{ ( github.event_name != 'pull_request' && github.ref == 'refs/heads/main' ) || github.ref_type == 'tag' || github.ref == 'refs/heads/ci' }}
    env:
      CHAT_ID: ${{ secrets.CHAT_ID }}
      BOT_TOKEN: ${{ secrets.BOT_TOKEN }}
      MESSAGE_THREAD_ID: ${{ secrets.MESSAGE_THREAD_ID }}
      COMMIT_MESSAGE: ${{ github.event.head_commit.message }}
      COMMIT_URL: ${{ github.event.head_commit.url }}
      RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
    steps:
      - name: Download artifacts
        uses: actions/download-artifact@v4

      - uses: actions/checkout@v4
        with:
          path: KernelSU
          fetch-depth: 0

      - name: List artifacts
        run: |
          tree

      - name: Download prebuilt toolchain
        run: |
          AOSP_MIRROR=https://android.googlesource.com
          BRANCH=main-kernel-build-2024
          git clone $AOSP_MIRROR/platform/prebuilts/build-tools -b $BRANCH --depth 1 build-tools
          git clone $AOSP_MIRROR/kernel/prebuilts/build-tools -b $BRANCH --depth 1 kernel-build-tools
          git clone $AOSP_MIRROR/platform/system/tools/mkbootimg -b $BRANCH --depth 1
          pip3 install telethon

      - name: Set boot sign key
        env:
          BOOT_SIGN_KEY: ${{ secrets.BOOT_SIGN_KEY }}
        run: |
          if [ ! -z "$BOOT_SIGN_KEY" ]; then
            echo "$BOOT_SIGN_KEY" > ./kernel-build-tools/linux-x86/share/avb/testkey_rsa2048.pem
          fi

      - name: Bot session cache
        id: bot_session_cache
        uses: actions/cache@v4
        if: false
        with:
          path: scripts/ksubot.session
          key: ${{ runner.os }}-bot-session

      - name: Build boot images
        run: |
          export AVBTOOL=$GITHUB_WORKSPACE/kernel-build-tools/linux-x86/bin/avbtool
          export GZIP=$GITHUB_WORKSPACE/build-tools/path/linux-x86/gzip
          export LZ4=$GITHUB_WORKSPACE/build-tools/path/linux-x86/lz4
          export MKBOOTIMG=$GITHUB_WORKSPACE/mkbootimg/mkbootimg.py
          export UNPACK_BOOTIMG=$GITHUB_WORKSPACE/mkbootimg/unpack_bootimg.py
          cd $GITHUB_WORKSPACE/KernelSU
          export VERSION=$(($(git rev-list --count HEAD) + 10200))
          echo "VERSION: $VERSION"
          cd -
          bash $GITHUB_WORKSPACE/KernelSU/.github/scripts/build_a13.sh

      - name: Display structure of boot files
        run: ls -R

      - name: Upload images artifact
        uses: actions/upload-artifact@v4
        with:
          name: boot-images-android13
          path: Image-android13*/*.img.gz

  check-build-kernel:
    if: (github.event_name == 'pull_request' && !github.event.pull_request.draft) || github.ref == 'refs/heads/checkci'
    strategy:
      matrix:
        include:
          - version: "5.10"
            sub_level: 218
            os_patch_level: 2024-08
          - version: "5.15"
            sub_level: 151
            os_patch_level: 2024-08
    uses: ./.github/workflows/gki-kernel.yml
    with:
      version: android13-${{ matrix.version }}
      version_name: android13-${{ matrix.version }}.${{ matrix.sub_level }}
      tag: android13-${{ matrix.version }}-${{ matrix.os_patch_level }}
      os_patch_level: ${{ matrix.os_patch_level }}
      patch_path: ${{ matrix.version }}

对上面的工作流文件的详细解释:

工作流名称
name: Build Kernel - Android 13:定义了工作流的名称。
触发器 on
push:当向 main、ci 或 checkci 分支推送代码时触发。
pull_request:当向 main 分支发起拉取请求时触发。
workflow_call:允许其他工作流调用此工作流。
paths:指定了触发工作流的文件路径,只有当这些文件被修改时,工作流才会运行。
作业 jobs
build-kernel:定义了一个名为 build-kernel 的作业。
if:条件语句,用于确定何时运行作业。这里排除了 pull_request 事件和 checkci 分支。
strategy.matrix:定义了一个矩阵策略,用于生成不同的作业变体。每个变体都有不同的 version、sub_level 和 os_patch_level。
uses:指定了要使用的另一个工作流文件 gki-kernel.yml。
secrets:设置为 inherit,意味着这个作业将继承父工作流的所有秘密(如 API 密钥等)。
with:传递参数到 gki-kernel.yml 工作流。
上传工件 upload-artifacts
needs:指定这个作业依赖于 build-kernel 作业。
runs-on:指定在 ubuntu-latest 虚拟机上运行。
if:条件语句,用于确定何时运行这个作业。这里包括了主分支的推送、标签的创建或 ci 分支的推送。
env:定义了环境变量,这些变量通常用于配置通知或其他脚本。
steps:定义了作业的步骤,包括下载工件、检出代码、列出工件、下载预构建工具链、设置引导签名密钥、缓存机器人会话、构建引导镜像、显示引导文件结构和上传引导镜像工件。
检查构建 check-build-kernel
if:条件语句,用于确定何时运行这个作业。这里包括了非草稿的拉取请求或 checkci 分支。
strategy.matrix:定义了一个矩阵策略,用于生成不同的作业变体。
uses:指定了要使用的另一个工作流文件 gki-kernel.yml。
with:传递参数到 gki-kernel.yml 工作流。

这篇关于github中action作用和讲解的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1136098

相关文章

计算机毕业设计 大学志愿填报系统 Java+SpringBoot+Vue 前后端分离 文档报告 代码讲解 安装调试

🍊作者:计算机编程-吉哥 🍊简介:专业从事JavaWeb程序开发,微信小程序开发,定制化项目、 源码、代码讲解、文档撰写、ppt制作。做自己喜欢的事,生活就是快乐的。 🍊心愿:点赞 👍 收藏 ⭐评论 📝 🍅 文末获取源码联系 👇🏻 精彩专栏推荐订阅 👇🏻 不然下次找不到哟~Java毕业设计项目~热门选题推荐《1000套》 目录 1.技术选型 2.开发工具 3.功能

Android fill_parent、match_parent、wrap_content三者的作用及区别

这三个属性都是用来适应视图的水平或者垂直大小,以视图的内容或尺寸为基础的布局,比精确的指定视图的范围更加方便。 1、fill_parent 设置一个视图的布局为fill_parent将强制性的使视图扩展至它父元素的大小 2、match_parent 和fill_parent一样,从字面上的意思match_parent更贴切一些,于是从2.2开始,两个属性都可以使用,但2.3版本以后的建议使

如何提高 GitHub 的下载速度

如何提高 GitHub 的下载速度 文章目录 如何提高 GitHub 的下载速度1. 注册账号2. 准备好链接3. 创建仓库4. 在码云上下载代码5. 仓库更新了怎么办 一般来说,国内的朋友从 GitHub 上面下载代码,速度最大是 20KB/s,这种龟速,谁能忍受呢? 本文介绍一种方法——利用“码云”,可以大大提高下载速度,亲测有效。 1. 注册账号 去“码云”注册一

maven发布项目到私服-snapshot快照库和release发布库的区别和作用及maven常用命令

maven发布项目到私服-snapshot快照库和release发布库的区别和作用及maven常用命令 在日常的工作中由于各种原因,会出现这样一种情况,某些项目并没有打包至mvnrepository。如果采用原始直接打包放到lib目录的方式进行处理,便对项目的管理带来一些不必要的麻烦。例如版本升级后需要重新打包并,替换原有jar包等等一些额外的工作量和麻烦。为了避免这些不必要的麻烦,通常我们

未来工作趋势:零工小程序在共享经济中的作用

经济在不断发展的同时,科技也在飞速发展。零工经济作为一种新兴的工作模式,正在全球范围内迅速崛起。特别是在中国,随着数字经济的蓬勃发展和共享经济模式的深入推广,零工小程序在促进就业、提升资源利用效率方面显示出了巨大的潜力和价值。 一、零工经济的定义及现状 零工经济是指通过临时性、自由职业或项目制的工作形式,利用互联网平台快速匹配供需双方的新型经济模式。这种模式打破了传统全职工作的界限,为劳动

Github连接方式

打开Linux中git的配置文件: /home/username/git/MyRepository/.git/config [core]repositoryformatversion = 0filemode = truebare = falselogallrefupdates = true[remote "origin"]fetch = +refs/heads/*:refs/remot

GitHub每周最火火火项目(9.2-9.8)

项目名称:polarsource / polar 项目介绍:polar 是一个开源项目,它是 Lemon Squeezy 的替代方案,并且具有更具优势的价格。该项目的目标是为开发者提供一种更好的选择,让他们能够在追求自己的热情和兴趣的同时,通过编码获得相应的报酬。通过使用 polar,开发者可以享受到更实惠的价格,同时也能够更自由地发挥自己的创造力和技能。 项目地址:https://github.

Science|癌症中三级淋巴结构的免疫调节作用与治疗潜力|顶刊精析·24-09-08

小罗碎碎念 Science文献精析 今天精析的这一篇综述,于2022-01-07发表于Science,主要讨论了癌症中的三级淋巴结构(Tertiary Lymphoid Structures, TLS)及其在肿瘤免疫反应中的作用。 作者类型作者姓名单位名称(中文)通讯作者介绍第一作者Ton N. Schumacher荷兰癌症研究所通讯作者之一通讯作者Daniela S. Thomm

Unable to instantiate Action, goodsTypeAction, defined for 'goodsType_findAdvanced' in namespace '/

报错: Unable to instantiate Action, goodsTypeAction,  defined for 'goodsType_findAdvanced' in namespace '/'goodsTypeAction......... Caused by: java.lang.ClassNotFoundException: goodsTypeAction.......

ispunct函数讲解 <ctype.h>头文件函数

目录 1.头文件函数 2.ispunct函数使用  小心!VS2022不可直接接触,否则..!没有这个必要,方源一把抓住VS2022,顷刻 炼化! 1.头文件函数 以上函数都需要包括头文件<ctype.h> ,其中包括 ispunct 函数 #include<ctype.h> 2.ispunct函数使用 简述: ispunct函数一种判断字符是否为标点符号的函