fix(changelog-github): Throw descriptive error when no options (#298)

* fix(changelog-github): Throw descriptive error when no options * Create sour-hats-hear.md Co-authored-by: Ben Conolly <ben@thinkmill.com.au>
changesets · Mar 28, 2020 · e56928b · e56928b
1 parent f930a68
commit e56928b
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/.changeset/sour-hats-hear.md b/.changeset/sour-hats-hear.md
@@ -0,0 +1,6 @@
+---
+"@changesets/changelog-github": patch
+"@changesets/types": patch
+---
+
+In changelog-github, throw more descriptive error when no options are provided.
diff --git a/packages/changelog-github/src/index.ts b/packages/changelog-github/src/index.ts
@@ -39,7 +39,7 @@ const changelogFunctions: ChangelogFunctions = {
     return [changesetLink, ...updatedDepenenciesList].join("\n");
   },
   getReleaseLine: async (changeset, type, options) => {
-    if (!options.repo) {
+    if (!options || !options.repo) {
       throw new Error(
         'Please provide a repo to this changelog generator like this:\n"changelog": ["@changesets/changelog-github", { "repo": "org/repo" }]'
       );

diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts
@@ -81,7 +81,7 @@ export type ModCompWithPackage = ComprehensiveRelease & {
 export type GetReleaseLine = (
   changeset: NewChangesetWithCommit,
   type: VersionType,
-  changelogOpts: any
+  changelogOpts: null | Record<string, any>
 ) => Promise<string>;
 
 export type GetDependencyReleaseLine = (