如何写一个其他人可以使用的GitHub Action

前言

在GitHub中，你肯定会使用GitHub Actions自动部署一个项目到GitHub Page上，在这个过程中总要使用workflows工作流，并在其中使用action，在这个使用的过程中，总会好奇怎么去写一个action呢，所以，我对此进行了一个学习。

什么是GitHub Actions

  • 官方概述如下：

GitHub Actions 是一种持续集成和持续交付 (CI/CD) 平台，可用于自动执行生成、测试和部署管道。 您可以创建工作流程来构建和测试存储库的每个拉取请求，或将合并的拉取请求部署到生产环境。

GitHub Actions 不仅仅是 DevOps，还允许您在存储库中发生其他事件时运行工作流程。 例如，您可以运行工作流程，以便在有人在您的存储库中创建新问题时自动添加相应的标签。

GitHub 提供 Linux、Windows 和 macOS 虚拟机来运行工作流程，或者您可以在自己的数据中心或云基础架构中托管自己的自托管运行器。

  • 上述关键词：CI/CD，持续集成由很多操作组成，比如拉取代码、限定npm版本、下载依赖、运行测试、docker部署，发布到第三方服务等等。GitHub 把这些操作就称为 actions。

  • 其实很多操作在不同项目里面都是类似的，完全可以使用相同的代码逻辑。GitHub允许开发者把每个操作写成独立的脚本文件，存放到代码仓库，使得其他开发者可以引用。

  • 如果说你需要某个 action，不必自己写复杂的脚本，直接引用他人写好的 action 就行，整个持续集成过程，就变成了一个 actions 的组合。这就是 GitHub Actions 最特别的地方。

  • GitHub 做了一个官方市场，可以搜索到他人提交的 actions。

如何写一个GitHub Action

经常使用其他人写好的action，或者说觉得其他人写的action并不好用，难免有时候会想自己写一个

  • 在上文中提到，GitHub允许开发者把每个操作写成独立的脚本文件，存放到代码仓库，使得其他开发者可以引用。

初始化一个项目仓库

  • 在GitHub新建一个代码仓库

  • 本地初始化项目，并与远程仓库相连接

npm init -y

action.yml文件

  • 在项目的根目录下，新建action.yml文件
  • 以下是我写的action的部分action.yml文件代码，也包含注释
name: 'action-demo' # action的名字
description: 'GitHub Action data-cards' # 描述
author: 'lxKylin' # 作者
# 定义输入参数
inputs:github_token: # 参数description: 'Your GitHub token for authentication.' # 描述required: true # 是否必须
# 定义输出参数
outputs:result:description: 'action-demo'
runs: # 脚本运行环境using: node16main: 'dist/index.js' # 执行入口

安装必要的依赖

@actions/core
npm install @actions/core
  • @actions/core 用于创建和管理 GitHub Actions 的工作流程。它提供了一些基本的功能，帮助你在工作流程中定义输入参数、设置环境变量、输出结果等。
  • 提到定义输入参数，在上文的action.yml文件中，我们定义了一个叫github_token的输入参数，我们可以根据@actions/core包中的getInput()方法获取到：
const core = require('@actions/core')const token = core.getInput('github_token')
@actions/github
npm install @actions/github
  • @actions/github 包允许你在 GitHub Actions 工作流中访问触发动作的事件负载、上下文和仓库信息。通过这个包，你可以轻松地获取有关触发动作的信息，例如推送到仓库的提交信息、触发工作流的事件类型等。
const github = require('@actions/github')// 上下文信息
const context = github.context
// 仓库所有者
const owner = context.repo.owner
// 仓库名
const repo = context.repo.repo
  • 通过owner和repo，我可以用之对相应的仓库进行提交等操作
@vercel/ncc
  • @vercel/ncc可以将一个 Node.js 模块及其依赖项打包到一个单一的 JavaScript 文件中，这有助于提高应用程序的性能和加载速度。这个工具的主要目的是减少模块的加载时间，使应用能够更快地启动和执行。
npm install @vercel/ncc
  • 这将以main.js为入口文件，在指定的目录dist中生成一个单一的文件(index.js)，其中包含了你的 Node.js 模块及其依赖项。
ncc build main.js -o dist
  • package.json
"scripts": {"build": "ncc build main.js -o dist"},
  • 完成以上几步，写一个action项目的架子就已经搭好了，其余就是写你的action需要的逻辑了
  • 你需要注意的是，在你具体的action逻辑代码有所修改后，一定要执行npm run build进行重新打包生成dist文件夹，这样代码提交后，使用这个action时才是你最新的代码。
  • 如果你觉得每次修改完代码都得重新npm run build有点烦，那么你完全可以在action项目中写一个ci，当你的代码提交时，自动打包，并将更新的代码提交到该分支

自动打包并提交

  • 在上文中提到，可以写一个ci自动打包并提交代码，完整的代码如下：
name: Upload Action Fileon:push:branches:- actionworkflow_dispatch:jobs:Upload_Action_File:runs-on: ubuntu-latest # 运行环境steps:- name: Checkout code # 获取仓库代码uses: actions/checkout@v2- name: Setup Node.jsuses: actions/setup-node@v3 #安装node.jswith:node-version: '16'- name: install & buildrun: |echo "npm run build"npm installnpm run build- name: Upload Action Fileuses: actions/upload-artifact@v4with:name: index.jspath: dist- name: Download Action Fileuses: actions/download-artifact@v4with:name: index.jspath: dist # 指定下载到本地的路径- name: Delete Image Folderrun: |echo "开始删除dist/image文件夹"rm -rf dist/imageecho "成功删除dist/image文件夹"shell: bash- name: Commit and Push Changesrun: |echo "Commit and Push Changes"git config --global user.name "${GITHUB_ACTOR}"# git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"git config --global user.email "actions@github.com"git add .git commit -m "feat: Update Action File"# origin 是远程仓库的默认名称，而 HEAD:main 表示将本地的 HEAD 分支（通常是当前分支）推送到远程仓库的 action 分支git push origin HEAD:actionenv:GH_TOKEN: ${{ secrets.DATA_CARD_TOKEN }}
  • name是这个workflows工作流的名称
  • on表示触发这个workflows的条件，在上述代码中，当action分支有push操作时，便执行这个工作流
    • 也有数组写法：[push, pull_request]，表示push、pull_request都将触发这个工作流
    • workflow_dispatch表示这个工作流可以手动触发：

image.png

  • jobs表示的是任务，其下的Upload_Action_File是任务的名称，是可以自定义的，每一个任务都是异步执行执行的，如果说，你需要每一步都按照顺序来，你可以这样使用needs：
jobs:job1:job2:needs: job1job3:needs: [job1, job2]

  • runs-on表示运行环境，一般就是ubuntu-latest

  • steps表示任务的步骤

    • name就表示这个步骤的名字，如果说，你是直接使用他人写好的action，那么可以使用uses进行引用
    • with，这里表示的是作业级别使用with来定义步骤的配置。像这里with: node-version: '16'就是你使用with指定node的版本，它还可以指定步骤的运行环境、虚拟机的操作系统、以及其他特定于作业的参数

  • actions/upload-artifact@v4和actions/download-artifact@v4是步骤间共享数据所使用到的action，前者表示将生成的文件上传，后者表示将文件下载

    • 在这里，在执行npm run build时，会生成dist文件夹，我们需要拿到这个文件夹中的文件，所以需要用到步骤间的数据共享

  • 在Commit and Push Changes这一步骤呢就是平常我们配置git的操作，设置用户名称和邮箱

    • "${GITHUB_ACTOR}"这个可以获取到你的账户名
    • "${GITHUB_ACTOR}@users.noreply.github.com"这个可以获取到你在github设置的邮箱。而"actions@github.com"相当于使用action用户进行提交，最后的就是我们平时提交代码时的步骤啦

  • 最后这个env: GH_TOKEN: ${{ secrets.DATA_CARD_TOKEN }}，需要到下图所示的地方进行生成一个具有你仓库读写权限的token

image.png

  • 在上面生成token后，再到下图所示的地方进行配置

image.png

  • 最后最后，为了确保这个workflows可以正常执行，在下图所示，你也需要给足workflows读写的权限

image.png

例子：data-card

  • 这个action是在学习写一个action项目时写的一个用于生成网页数据的卡片，比如：掘金、CSDN、力扣、语雀等，当然，这种数据卡片，最好还是使用img标签使用api直接请求后端返回图片。这个仅作为一个学习的例子。

  • 使用方法：

name: generate-data-cardon:schedule:- cron: '0 0 * * *'workflow_dispatch:jobs:generate-card:runs-on: ubuntu-lateststeps:- name: Use Data Card Actionuses: lxKylin/data-card@actionwith:github_token: ${{ secrets.DATA_CARD_TOKEN }}juejin_id: ${{ secrets.JUEJIN_PARAMS }} # 也可不使用变量，直接写juejin_id

image.png

image.png

  • 该项目不断完善中

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://xiahunao.cn/news/2776047.html

如若内容造成侵权/违法违规/事实不符，请联系瞎胡闹网进行投诉反馈，一经查实，立即删除！

相关文章

数字图像处理实验记录六（图像的傅里叶变换和频域处理）

数字图像处理实验记录六（图像的傅里叶变换和频域处理）

前言： 一、基础知识 1，傅里叶变换是什么 傅里叶变换是一种线性积分变换，通俗来说，通过傅里叶变换就是把一段信号分解成若干个简谐波。 二、实验要求 1．产生一幅如图所示亮块图像f(x,y)（256256 大小、…
阅读更多...
Project2007下载安装教程，保姆级教程，附安装包和工具

Project2007下载安装教程，保姆级教程，附安装包和工具

前言 Project是一款项目管理软件，不仅可以快速、准确地创建项目计划，而且可以帮助项目经理实现项目进度、成本的控制、分析和预测，使项目工期大大缩短，资源得到有效利用，提高经济效益。软件设计目的在于协助专案经理发…
阅读更多...
数据结构入门（1）数据结构介绍

数据结构入门（1）数据结构介绍

目录 前言 1. 什么是数据结构？ 2.什么是算法？ 3.数据结构和算法的重要性 前言 本文将开始介绍计算机里的数据结构。 数据结构是指数据对象中元素之间的关系，以及对这些关系的操作。数据结构可以分为线性结构和非线性结构。 线性结构是…
阅读更多...
【MySQL进阶之路】BufferPool底层设计（下）

【MySQL进阶之路】BufferPool底层设计（下）

欢迎关注公众号（通过文章导读关注：【11来了】），及时收到 AI 前沿项目工具及新技术的推送！ 在我后台回复 「资料」 可领取编程高频电子书！ 在我后台回复「面试」可领取硬核面试笔记！ 文章导读地址…
阅读更多...
（基础算法）归并排序

（基础算法）归并排序

1.确定分界点 mid &#xff08;lr&#xff09;/2 2.递归排序左右两段 3.归并----合二为一 #include<iostream> using namespace std; //归并排序----分治 const int N10010; int n; int q[N],tmp[N];//需要一个额外数组void mergesort(int q[],int l,int r)//l左边界&a…
阅读更多...
深度学习技巧应用36-深度学习模型训练中的超参数调优指南大全,总结相关问题与答案

深度学习技巧应用36-深度学习模型训练中的超参数调优指南大全,总结相关问题与答案

大家好，我是微学AI，今天给大家介绍一下深度学习技巧应用36-深度学习模型训练中的超参数调优指南大全,总结相关问题与答案。深度学习模型训练中的调优指南大全概括了数据预处理、模型架构设计、超参数优化、正则化策略和训练技巧等多个关键方面，以提升模型性能和泛化能力。 …
阅读更多...
Spring 的奇幻起源：从 IoC 容器到 Bean 的魔法世界 ✨

Spring 的奇幻起源：从 IoC 容器到 Bean 的魔法世界 ✨

目录 什么是 Spring&#xff1f;为什么它如此流行&#xff1f; IoC 容器&#xff1a;从“依赖倒置”到“控制反转” Bean&#xff1a;IoC 容器中的基本组件 Spring 中的配置方式&#xff1a;XML、注解和 JavaConfig Bean 的作用域和生命周期管理 Bean 的属性装配和自动装配…
阅读更多...
C 语言学习七：指针

C 语言学习七：指针

指针 指针与地址指针的声明和初始化指针的解引用指针的比较指针和数组指针数组指针和动态内存分配 指针与函数参数指针作为函数参数二级指针 指向函数的指针 指针与地址 指针的声明和初始化 int variable 42; int *ptr &variable; //间接访问 int value *ptr; // valu…
阅读更多...
AD9361多片同步设计方法

AD9361多片同步设计方法

本文基于ZC706FMCOMMS5的平台&#xff0c;介绍了多片AD9361同步的方法。并将该设计移植到自行设计的ZYNQ70354片AD9361(实现8路同步收发)的电路板上。本设计采用纯逻辑的方式&#xff0c;仅使用了ZYNQ芯片的PL部分。 9361多芯片同步主要包括基带同步和射频同步两大块任务。其中…
阅读更多...
nacos配置自动刷新源码解析

nacos配置自动刷新源码解析

文章目录 一、前言二、源码解析1、nacos客户端如何监听服务端配置变化的2、ConfigurationProperties注解的bean是如何自动刷新的3、RefreshScope 注解的bean是如何自动刷新的 三、总结 一、前言 最近好奇 nacos 是怎么做到配置自动刷新的&#xff0c;于是就去debug跟了下源码&…
阅读更多...
使用CURL命令实现tftp和ftp客户端功能

使用CURL命令实现tftp和ftp客户端功能

要使用curl命令实现FTP文件发送&#xff0c;您需要使用以下命令格式&#xff1a; curl -T <local_file_path> -u <username>:<password> ftp://<ftp_server_address>/<remote_file_path> 其中: <local_file_path> 是本地文件的路径&…
阅读更多...
下载已编译的 OpenCV 包在 Visual Studio 下实现快速配置

下载已编译的 OpenCV 包在 Visual Studio 下实现快速配置

自己编译 OpenCV 挺麻烦的&#xff0c;配置需要耗费很长时间&#xff0c;编译也需要很长时间&#xff0c;而且无法保证能全部编译通过。利用 OpenCV 官网提供的已编译的 OpenCV 库可以节省很多时间。下面介绍安装配置方法。 1. OpenCV 官网 地址是&#xff1a;https://opencv…
阅读更多...
【Redis】深入理解 Redis 常用数据类型源码及底层实现(3.详解String数据结构)

【Redis】深入理解 Redis 常用数据类型源码及底层实现(3.详解String数据结构)

【Redis】深入理解 Redis 常用数据类型源码及底层实现&#xff08;1.结构与源码概述&#xff09;-CSDN博客 【Redis】深入理解 Redis 常用数据类型源码及底层实现(2.版本区别dictEntry & redisObject详解)-CSDN博客 紧接着前两篇的总体介绍&#xff0c;从这篇开始&#x…
阅读更多...
yo！这里是Linux线程保姆级入门介绍

yo！这里是Linux线程保姆级入门介绍

目录 前言 Linux线程基础 线程概念 底层示意图 线程vs进程 Linux线程控制 创建线程 线程ID 线程终止 线程等待 线程分离 Linux线程互斥 背景概念 互斥量mutex 1.相关接口 2.实现原理 可重入vs线程安全 死锁 Linux线程同步 条件变量 生产者消费者模型 基于…
阅读更多...
排序算法---堆排序

排序算法---堆排序

原创不易&#xff0c;转载请注明出处。欢迎点赞收藏~ 堆排序&#xff08;Heap Sort&#xff09;是一种基于二叉堆数据结构的排序算法。它将待排序的元素构建成一个最大堆&#xff08;或最小堆&#xff09;&#xff0c;然后逐步将堆顶元素与堆的最后一个元素交换位置&#xff0c…
阅读更多...
Cilium CNI深度指南

Cilium CNI深度指南

Cilium是基于eBPF的功能强大的CNI插件&#xff0c;为云原生环境提供了强大的网络和安全支持。原文: Cilium CNI: A Comprehensive Deep Dive Guide for Networking and Security Enthusiasts! &#x1f313;简介 欢迎阅读为网络和安全爱好者提供的全面深入的指南&#xff01; 本…
阅读更多...
深度分析一款新型Linux勒索病毒

深度分析一款新型Linux勒索病毒

前言 DarkRadiation勒索病毒是一款全新的Linux平台下的勒索病毒&#xff0c;2021年5月29日首次在某平台上发布了此勒索病毒的相关的信息&#xff0c;6月中旬趋势科技针对这个新型的勒索病毒进行了相关的分析和报道。 DarkRadiation勒索病毒采用Bash脚本语言编写实现&#xff0…
阅读更多...
恒流源方案对比

恒流源方案对比

1、双运放恒流源 2、运放三极管放大电路组成的恒流源 5A 3、运放三极管组成的恒流源 200uA 4、运放MOS管组成的恒流源 100mA 5、电源模块并联输出100A恒流
阅读更多...
【前沿技术杂谈：多模态文档基础模型】使用多模态文档基础模型彻底改变文档 AI

【前沿技术杂谈：多模态文档基础模型】使用多模态文档基础模型彻底改变文档 AI

【前沿技术杂谈&#xff1a;多模态文档基础模型】使用多模态文档基础模型彻底改变文档 AI 从文本到多模态模型&#xff1a;文档 AI 逐渐发展新技能。行业领先的型号Document AI 的下一步&#xff1a;开发通用和统一框架 您是否曾经被包含不同信息&#xff08;如应付账款、日期、…
阅读更多...
通过nginx学习linux进程名的修改

通过nginx学习linux进程名的修改

目录 1. 缘起2. 背景知识3. 源码分析3.1 准备工作3.2 设置进程名字 1. 缘起 在运行nginx的时候&#xff0c;用ps查看nginx的进程信息&#xff0c;可能的输出如下&#xff1a; root 42169 3105 0 16:51 ? 00:00:00 nginx: master process ./objs/nginx root …
阅读更多...
最新文章

Copyright @ 2022~2023