Repository Overview
Navigate to your repository on GitHub. You should see these key files:| File | Purpose |
|---|---|
.gitignore | Excludes files from version control |
README.md | Project overview and usage instructions |
index.js | Entry point for the JavaScript logic |
action.yml | Metadata for GitHub Actions and Marketplace |
Prerequisites
Before publishing, make sure you have:- Accepted the GitHub Marketplace Terms
- Enabled Two-Factor Authentication (2FA) on your account
GitHub requires 2FA for all Marketplace publishers. If you haven’t set it up yet, follow the prompts under Settings → Security → Two-factor authentication.
Initial Publishing Attempt
When you click Create new release, GitHub validates youraction.yml. Common errors include:
- A non-unique
namefield - Missing
brandingsection (icon or color)
If you see “Action name must be unique” or “Branding information missing,” update your
action.yml before you can publish.Update action.yml Metadata
Openaction.yml in your editor and ensure the following fields are defined:
| Field | Description | Example |
|---|---|---|
name | Unique identifier for your action | KodeKloud Giphy PR Comment |
description | Short summary of what the action does | Add a Giphy GIF comment to PRs |
inputs | Required parameters (token, API keys, etc.) | github-token, giphy-api-key |
runs | Runtime environment and entry point | using node20, main dist/index.js |
branding | Marketplace icon and color | icon award, color green |
Create a Release
- On GitHub, click Create new release.
- Enter the Tag (e.g.,
1.0.0-alpha), Title (e.g., Alpha Release), and a brief Description (e.g., “Demo release for the Giphy PR comment action.”). - Publish the release.
Verify Release Downloads
After publishing, the release page will display download links:- Source code (ZIP)
- Source code (tar.gz)
View the Marketplace Listing
Your action is now live! Click the View it on GitHub Marketplace link provided on the release page to see the “KodeKloud Giphy PR Comment” listing. You can further enhance your listing by adding:- Usage examples
- Detailed configuration instructions
- Screenshots or GIFs