Action Plugin Development

This directory contains the decomposed documentation of the "AtomGit Actions Plugin Development Specification". The content is sourced from the original specification file. It covers the plugin project structure, metadata syntax, top-level fields, runtime environment variables, development guidelines, security standards, testing, packaging, and release.

📄️ Plugin Project Structure

Developing an AtomGit Actions plugin requires following a series of specifications and best practices, covering the definition of plugin metadata, code development, and the complete process of referencing the plugin.

📄️ action.yml Metadata Syntax

action.yml is the core configuration file of the plugin, containing information such as the plugin's metadata, inputs and outputs, and runtime environment. Use action.yml to identify and load the plugin.

📄️ Top-level Fields

This document defines the configuration specifications for top-level fields in plugin development, including plugin metadata, the declaration of input and output parameters, and the configuration of execution methods.

📄️ Runtime Environment Variables

Pipeline System Variables

📄️ Plugin Development Guide

Language: TypeScript is recommended for plugin code.

📄️ Plugin Security Standards

Plugin security standards require that sensitive data must not be hardcoded, must be obtained through secure input, encrypted storage, and timely cleanup, and all input parameters must be strictly validated.

📄️ Plugin Packaging

The Atomgit Actions plugin requires executing build commands to generate executable js files, which can be directly referenced and executed in the pipeline. The build process is orchestrated through configuration in package.json.