开源项目 `action-automatic-releases` 使用教程

开源项目 action-automatic-releases 使用教程

action-automatic-releases READONLY: Auto-generated mirror for https://github.com/marvinpinto/actions/tree/master/packages/automatic-releases 项目地址: https://gitcode.com/gh_mirrors/ac/action-automatic-releases

1. 项目的目录结构及介绍

action-automatic-releases 项目的目录结构如下：

action-automatic-releases/
├── dist/
│   └── ...
├── LICENSE
├── README.md
└── action.yml

目录结构介绍

• dist/: 该目录包含项目的构建输出文件。通常，这些文件是编译后的代码或打包后的资源。
• LICENSE: 项目的许可证文件，本项目使用 MIT 许可证。
• README.md: 项目的说明文档，包含项目的概述、使用方法、配置等信息。
• action.yml: 项目的配置文件，定义了 GitHub Actions 的工作流程和参数。

2. 项目的启动文件介绍

action-automatic-releases 项目的主要启动文件是 action.yml。该文件定义了 GitHub Actions 的工作流程和参数，确保项目能够自动生成和发布版本。

action.yml 文件内容概述

name: "Automatic Releases"
description: "Simplifies the GitHub release process by automatically uploading assets, generating changelogs, handling pre-releases, and so on."
inputs:
  repo_token:
    description: "GitHub Action token, e.g., $[[ secrets.GITHUB_TOKEN ]]"
    required: true
  automatic_release_tag:
    description: "Tag name to use for automatic releases, e.g., latest"
    required: false
  prerelease:
    description: "Mark this release as a pre-release"
    default: true
    required: false
  title:
    description: "Release title, defaults to the tag name if none specified"
    required: false
  files:
    description: "Files to upload as part of the release assets"
    required: false
outputs:
  automatic_releases_tag:
    description: "The release tag this action just processed"
  upload_url:
    description: "The URL for uploading additional assets to the release"
runs:
  using: "node12"
  main: "dist/index.js"

启动文件介绍

• name: 定义了 Action 的名称。
• description: 提供了 Action 的简要描述。
• inputs: 定义了 Action 的输入参数，包括 repo_token、automatic_release_tag、prerelease、title 和 files。
• outputs: 定义了 Action 的输出参数，包括 automatic_releases_tag 和 upload_url。
• runs: 指定了 Action 的运行环境（使用 Node.js 12）和主入口文件（dist/index.js）。

3. 项目的配置文件介绍

action-automatic-releases 项目的主要配置文件是 action.yml。该文件定义了 GitHub Actions 的工作流程和参数，确保项目能够自动生成和发布版本。

配置文件介绍

• repo_token: 必需参数，GitHub Action 的令牌，用于访问 GitHub API。
• automatic_release_tag: 可选参数，用于自动发布的标签名称。
• prerelease: 可选参数，标记发布为预发布版本。
• title: 可选参数，发布的标题。
• files: 可选参数，要上传为发布资产的文件。

通过配置这些参数，用户可以自定义发布流程，例如自动生成预发布版本、上传特定文件等。

总结

action-automatic-releases 项目通过 action.yml 文件定义了自动发布版本的流程。用户可以根据需要配置不同的参数，实现自动生成和发布 GitHub 版本的功能。项目的目录结构清晰，配置文件简单易懂，适合开发者快速上手使用。

action-automatic-releases READONLY: Auto-generated mirror for https://github.com/marvinpinto/actions/tree/master/packages/automatic-releases 项目地址: https://gitcode.com/gh_mirrors/ac/action-automatic-releases