added github issues

jerbly · Mar 27, 2024 · 44e7ccd · 44e7ccd
1 parent 9417ff7
commit 44e7ccd
Show file tree

Hide file tree

Showing 7 changed files with 992 additions and 65 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,11 @@
+# 0.5.0
+
+- GitHub Issue Generation
+  - The `-g` or `--github-issue` option can be used to create GitHub Issues for attribute and enum health. Provide the repo owner and name e.g. `myorg/myrepo`. You must have a [Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) that allows issue creation - put this in an environment variable `GITHUB_TOKEN` or a `.env` file.
+
+  - Honey-health will create a markdown table, split over multiple comments if necessary. Here are examples for [Attributes](https://github.com/jerbly/honey-health/issues/1) and [Enums](https://github.com/jerbly/honey-health/issues/2).
+
+
 # 0.4.3
 
 - Fixed: "Similar" suggestions were including deprecated attributes.