github-action-readme-generator 1.5.1 → 1.7.0

package/CHANGELOG.md

@@ -1,3 +1,30 @@
+# [1.7.0](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.6.0...v1.7.0) (2023-10-22)
+
+
+### Bug Fixes
+
+* **readme:** newlines missing around content sections in readme ([0ca9980](https://github.com/bitflight-devops/github-action-readme-generator/commit/0ca99809b643d5e82958dda81c6db5d7bdb1c423))
+
+
+### Features
+
+* **branding:** icons now correctly centered on circle ([2c26d93](https://github.com/bitflight-devops/github-action-readme-generator/commit/2c26d93f8452d77bf8516260f6fcfd45196e9590))
+* **branding:** new segment for readme generates action.yml branding svg ([07c3bbe](https://github.com/bitflight-devops/github-action-readme-generator/commit/07c3bbecc903787613d3ffcae016673785b1016d))
+* **engines:** update node engines to be >= 18, from 14 ([35b5d08](https://github.com/bitflight-devops/github-action-readme-generator/commit/35b5d089a2cb83cdf6bfe88a2bc45cf6aba90a12))
+* improve devx ([9f34cf8](https://github.com/bitflight-devops/github-action-readme-generator/commit/9f34cf8926303b84d2040ddb072ebe6bb6f9820d))
+
+# [1.6.0](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.5.1...v1.6.0) (2023-10-16)
+
+
+### Bug Fixes
+
+* **test:** inputs test was failing due to node20 bundling error ([7b5cac4](https://github.com/bitflight-devops/github-action-readme-generator/commit/7b5cac4d69c8fad291e374b3140a230dcf8ba358))
+
+
+### Features
+
+* **refactor:** make the readme sections update in memory before writing it out once ([a4468c1](https://github.com/bitflight-devops/github-action-readme-generator/commit/a4468c1bc0bf7c744402a4904baa87f2eec9f36e))
+
 ## [1.5.1](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.5.0...v1.5.1) (2023-10-14)
 
 

package/README.example.md

@@ -1,5 +1,7 @@
 <!-- start title -->
 <!-- end title -->
+<!-- start branding -->
+<!-- end branding -->
 <!-- start description -->
 <!-- end description -->
 <!-- start contents -->

package/README.md

@@ -1,17 +1,15 @@
+<!-- start branding -->
+<img src=".github/ghadocs/branding.svg" alt="book-open" />
+<!-- end branding -->
 <!-- start title -->
-
 # GitHub Action: 📓 GitHub Action's Readme Generator
-
 <!-- end title -->
 <!-- start badges -->
-
 <a href="https://github.com/bitflight-devops/github-action-readme-generator/releases/latest"><img src="https://img.shields.io/github/v/release/bitflight-devops/github-action-readme-generator?display_name=tag&sort=semver&logo=github&style=flat-square" alt="Release" /></a><a href="https://github.com/bitflight-devops/github-action-readme-generator/releases/latest"><img src="https://img.shields.io/github/release-date/bitflight-devops/github-action-readme-generator?display_name=tag&sort=semver&logo=github&style=flat-square" alt="Release" /></a><img src="https://img.shields.io/github/last-commit/bitflight-devops/github-action-readme-generator?logo=github&style=flat-square" alt="Commit" /><a href="https://github.com/bitflight-devops/github-action-readme-generator/issues"><img src="https://img.shields.io/github/issues/bitflight-devops/github-action-readme-generator?logo=github&style=flat-square" alt="Open Issues" /></a><img src="https://img.shields.io/github/downloads/bitflight-devops/github-action-readme-generator/total?logo=github&style=flat-square" alt="Downloads" />
-
 <!-- end badges -->
 <!-- start description -->
-
-Maintain a current README.md with content from the action.yml file
-
+Keep the README.md `usage`, `inputs` and `outputs` in sync with the `action.yml` file.
+Additionally the Action's usage example is updated to match the Action's current release.
 <!-- end description -->
 
 This is a CLI tool and GitHub Action that reads the details from a GitHub Action's `action.yml` file. It updates the `README.md` file with the `name`, `description`, `usage`, `inputs`, `outputs`, and examples of the action. Configuration can be provided through a `.ghadocs.json` file stored in the root directory of the Action's repository, via the command line when using the CLI, or through the `with:` section of this Action.
@@ -38,7 +36,6 @@ This is a CLI tool and GitHub Action that reads the details from a GitHub Action
 ### Stand Alone Usage - if you have a Docker Action
 
 ```sh
-sh
 npx --yes github-action-readme-generator@latest
 ```
 
@@ -106,52 +103,40 @@ You can modify the script below to include any extra variables you like or use n
 <!-- start usage -->
 
 ```yaml
-- uses: bitflight-devops/github-action-readme-generator@v1.3.15--canary.8238c73.0
+- uses: bitflight-devops/github-action-readme-generator@v1.6.0
   with:
-    # The absolute or relative path to the `action.yml` file to read in from.
     # Default: action.yml
     action: ''
 
-    # The absolute or relative path to the markdown output file that contains the
-    # formatting tokens within it.
     # Default: README.md
     readme: ''
 
-    # The GitHub Action repository owner. i.e: `bitflight-devops`|`your-gh-username`
     owner: ''
 
-    # The GitHub Action repository name. i.e: `github-action-readme-generator`
     repo: ''
 
-    # Save the provided values in a `.ghadocs.json` file. This will update any
-    # existing `.ghadocs.json` file that is in place.
     save: ''
 
-    # Use `prettier` to pretty print the new README.md file
     pretty: ''
 
-    # Enable the update of the usage version to match the latest version in the
-    # `package.json` file
     versioning_enabled: ''
 
-    # Set a specific version to display in the README.md
     version_override: ''
 
-    # Prefix the version with this value (if it isn't already prefixed)
     # Default: v
     version_prefix: ''
 
-    # If versioning is disabled show this branch instead
     # Default: main
     versioning_default_branch: ''
 
-    # Add a prefix to the README title
     # Default: GitHub Action:
     title_prefix: ''
 
-    # Include additional badge showing latest tag
     # Default: true
     include_github_version_badge: ''
+
+    # Default: .github/ghadocs/branding.svg
+    branding_svg_path: ''
 ```
 
 <!-- end usage -->
@@ -160,20 +145,21 @@ You can modify the script below to include any extra variables you like or use n
 
 <!-- start inputs -->
 
-| \***\*Input\*\***                             | \***\*Description\*\***                                                                                                                        | \***\*Default\*\***          | \***\*Required\*\*** |
-| --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -------------------- |
-| <code>**action**</code>                       | The absolute or relative path to the <code>action.yml</code> file to read in from.                                                             | <code>action.yml</code>      | **false**            |
-| <code>**readme**</code>                       | The absolute or relative path to the markdown output file that contains the formatting tokens within it.                                       | <code>README.md</code>       | **false**            |
-| <code>**owner**</code>                        | The GitHub Action repository owner. i.e: `bitflight-devops`\|`your-gh-username`                                                                |                              | **false**            |
-| <code>**repo**</code>                         | The GitHub Action repository name. i.e: <code>github-action-readme-generator</code>                                                            |                              | **false**            |
-| <code>**save**</code>                         | Save the provided values in a <code>.ghadocs.json</code> file. This will update any existing <code>.ghadocs.json</code> file that is in place. |                              | **false**            |
-| <code>**pretty**</code>                       | Use <code>prettier</code> to pretty print the new README.md file                                                                               |                              | **false**            |
-| <code>**versioning_enabled**</code>           | Enable the update of the usage version to match the latest version in the <code>package.json</code> file                                       |                              | **false**            |
-| <code>**version_override**</code>             | Set a specific version to display in the README.md                                                                                             |                              | **false**            |
-| <code>**version_prefix**</code>               | Prefix the version with this value (if it isn't already prefixed)                                                                              | <code>v</code>               | **false**            |
-| <code>**versioning_default_branch**</code>    | If versioning is disabled show this branch instead                                                                                             | <code>main</code>            | **false**            |
-| <code>**title_prefix**</code>                 | Add a prefix to the README title                                                                                                               | <code>GitHub Action: </code> | **false**            |
-| <code>**include_github_version_badge**</code> | Include additional badge showing latest tag                                                                                                    | <code>true</code>            | **false**            |
+| \***\*Input\*\***                  | \***\*Description\*\***                                                                                                  | \***\*Default\*\***            | \***\*Required\*\*** |
+| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------ | -------------------- |
+| `**action**`                       | The absolute or relative path to the `action.yml` file to read in from.                                                  | `action.yml`                   | **false**            |
+| `**readme**`                       | The absolute or relative path to the markdown output file that contains the formatting tokens within it.                 | `README.md`                    | **false**            |
+| `**owner**`                        | The GitHub Action repository owner. i.e: `bitflight-devops`\|`your-gh-username`                                          |                                | **false**            |
+| `**repo**`                         | The GitHub Action repository name. i.e: `github-action-readme-generator`                                                 |                                | **false**            |
+| `**save**`                         | Save the provided values in a `.ghadocs.json` file. This will update any existing `.ghadocs.json` file that is in place. |                                | **false**            |
+| `**pretty**`                       | Use `prettier` to pretty print the new README.md file                                                                    |                                | **false**            |
+| `**versioning_enabled**`           | Enable the update of the usage version to match the latest version in the `package.json` file                            |                                | **false**            |
+| `**version_override**`             | Set a specific version to display in the README.md                                                                       |                                | **false**            |
+| `**version_prefix**`               | Prefix the version with this value (if it isn't already prefixed)                                                        | `v`                            | **false**            |
+| `**versioning_default_branch**`    | If versioning is disabled show this branch instead                                                                       | `main`                         | **false**            |
+| `**title_prefix**`                 | Add a prefix to the README title                                                                                         | `GitHub Action: `              | **false**            |
+| `**include_github_version_badge**` | Include additional badge showing latest tag                                                                              | `true`                         | **false**            |
+| `**branding_svg_path**`            | Save and load the branding svg image in the README from this path                                                        | `.github/ghadocs/branding.svg` | **false**            |
 
 <!-- end inputs -->
 <!-- start outputs -->