adjusts YAML file to conform to GH marketplace requirements

CSchoel · Jan 11, 2022 · 81428e7 · 81428e7
1 parent c6082f3
commit 81428e7
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -19,11 +19,12 @@ nothing
 
 nothing
 
-## [1.2.0] - 2022-01-10
+## [1.2.0] - 2022-01-11
 
 ### Added
 
 * Test case for missing URL for footnote-style markdown link in CHANGELOG.md
+* Icon and color info in YAML file.
 
 ### Changed
 
@@ -33,6 +34,7 @@ nothing
 * Switches to `uses: ./` to use local version of action in all CI/CD scripts.
     This avoids the need to specify the action version within the CI/CD scripts and ensures that the current version is used.
 * Uses [GitHub CLI](https://cli.github.com/manual/gh_release_create) instead of [unmaintained `actions/create-release`](https://github.com/actions/create-release) both in README example and release script.
+* Adjusted `name` and `description` in YAML file to match requirements of GH marketplace.
 
 ### Fixed
 

diff --git a/action.yml b/action.yml
@@ -1,7 +1,8 @@
-name: Create release notes
-description: |
-  Extracts release notes for current tag from CHANGELOG.md and writes them to a file called RELEASE.md.
-  It is assumed that a header for RELEASE.md is found in the file RELEASE_HEAD.md.
+name: Create release notes from changelog
+description: Extracts release notes from CHANGELOG.md, combines them with a static header RELEASE_HEAD.md and writes them to RELEASE.md.
+branding:
+  icon: file-text
+  color: purple
 inputs:
   version:
     description: 'Version number to search for in CHANGELOG.md (default: use tag without leading v)'