UNPKG

github-action-readme-generator

Version:

This is a CLI tool and GitHub Action that reads in the details from a GitHub Action's `action.yml` file and updates the `README.md` file with the `name`, `description`, `usage`, `inputs`, `outputs`, and examples of the action. Configuration can be provid

65 lines (32 loc) 4.14 kB
# [1.8.0](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.7.2...v1.8.0) (2023-11-20) ### Bug Fixes * **defaults:** fix npm release blockage ([34e2f46](https://github.com/bitflight-devops/github-action-readme-generator/commit/34e2f465fb85774bf80e748f68204362298845c0)) ### Features * **refactor:** JSDocs added, Unit Tests added using ViTest, refactored for maintainability ([#239](https://github.com/bitflight-devops/github-action-readme-generator/issues/239)) ([0451f2c](https://github.com/bitflight-devops/github-action-readme-generator/commit/0451f2c7bbd93cefba4400589ca1d46fde7aa5f4)) ## [1.7.2](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.7.1...v1.7.2) (2023-10-24) ### Bug Fixes * **dist:** dist check was failing due to not installing optional dependencies ([347fb89](https://github.com/bitflight-devops/github-action-readme-generator/commit/347fb890c60ab60289f30ab6edd84f038923debd)) * **dist:** dist check was failing due to not installing optional dependencies ([9aa26d9](https://github.com/bitflight-devops/github-action-readme-generator/commit/9aa26d9bde139f2eb626a8901988b96c1117bbff)) * **markdown:** update formatting in tables to use <b> and <code> tags ([e950f20](https://github.com/bitflight-devops/github-action-readme-generator/commit/e950f20770bfd5621084c65e33184687b2b88de4)) * **usage:** usage section was missing descriptions ([8dc2738](https://github.com/bitflight-devops/github-action-readme-generator/commit/8dc273825c7a017ad8ba53d094a119b7f2c4a0c4)) * **usage:** usage section was missing its descriptions ([4d6e063](https://github.com/bitflight-devops/github-action-readme-generator/commit/4d6e06394d39fca2669c8dc5d58bdba3d19c1c34)) ## [1.7.1](https://github.com/bitflight-devops/github-action-readme-generator/compare/v1.7.0...v1.7.1) (2023-10-24) ### Bug Fixes * **nconf:** nconf released a fix for dynamic imports ([2e5c3c3](https://github.com/bitflight-devops/github-action-readme-generator/commit/2e5c3c3e4ed53905c8da13f0511c673b1ef83815)) # [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) ### Bug Fixes * only replace grave accents when vertical pipe ([e69fb0d](https://github.com/bitflight-devops/github-action-readme-generator/commit/e69fb0d2f3ccb197367f59c75ba87dd571cc2227)) * **release:** update the release workflows ([4f5b377](https://github.com/bitflight-devops/github-action-readme-generator/commit/4f5b377941793318606657fa6d9f1e56d91bb41c))