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

This document introduces the project directory structure, target audience, and scaffolding project for AtomGit Action plugins, serving as the starting point for plugin development.

📄️ action.yml Metadata Syntax

This document introduces the complete syntax of the plugin metadata file action.yml, including file format specifications, naming conventions, version number specifications, and a complete example.

📄️ Top-level Fields

This document introduces the complete definitions of top-level fields in action.yml, including the configuration rules for name, version, author, description, inputs, outputs, and runs.

📄️ Runtime Environment Variables

This document introduces the complete description of system environment variables, context, and runtime process files (such as ATOMGITENV, ATOMGITOUTPUT, etc.) available during plugin execution.

📄️ Plugin Development Guide

This document introduces how to write plugin core code using JavaScript/TypeScript, including parameter acquisition, log output, status feedback, result output, and post-processing.

📄️ Plugin Security Standards

This document introduces the security requirements in plugin development, including specifications for handling sensitive data, input parameter security validation, etc.

📄️ Plugin Packaging

This document introduces how to build and package the plugin code into an executable ZIP file, including build configuration, build steps, and package structure explanation.