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.

Target Audience

This document is aimed at developers of AtomGit Actions type plugins.

Plugin Project Structure

The directory structure of an AtomGit Actions plugin project is as follows:

action-repo/
├── dist/
│   └── index.js              # Plugin core code (build output)
│   └── stop.js               # [Optional] Code for post-processing after the plugin stops
├── action.yml                # Plugin metadata file
└── README.md                 # Plugin description document

Directory/File	Description
action.yml	Metadata file, defining core configurations such as plugin input parameters, output results, and execution files
dist/	Directory containing executable code, generated by the build tool
README.md	Detailed documentation about the plugin
Other	JS/TS project source code, with no strict requirements on directory structure