- add additional settings to ensure we won't spend the whole API quota if a merge included non anticipated commits

src/configuration.ts

@@ -1,4 +1,8 @@
 export interface Configuration {
+  max_tags_to_fetch: number,
+  max_pull_requests: number,
+  max_back_track_time_days: number,
+  exclude_merge_branches: string[],
   sort: string
   template: string
   pr_template: string
@@ -18,10 +22,14 @@ export interface Transformer {
 }
 
 export const DefaultConfiguration: Configuration = {
-  sort: 'ASC',
-  template: '${{CHANGELOG}}',
-  pr_template: '- ${{TITLE}}\n   - PR: #${{NUMBER}}',
-  empty_template: '- no changes',
-  categories: [],
-  transformers: []
+  max_tags_to_fetch: 200, // the amount of tags to fetch from the github API
+  max_pull_requests: 200, // the amount of pull requests to process
+  max_back_track_time_days: 90, // allow max of 90 days to check up on pull requests
+  exclude_merge_branches: [], // branches to exclude from counting as PRs (e.g. YourOrg/qa, YourOrg/main)
+  sort: 'ASC', // sorting order for filling the changelog (ASC or DESC) supported
+  template: '${{CHANGELOG}}', // the global template to host the changelog
+  pr_template: '- ${{TITLE}}\n   - PR: #${{NUMBER}}', // the per PR template to pick
+  empty_template: '- no changes', // the template to use if no pull requests are found
+  categories: [], // the categories to support for the ordering
+  transformers: []  // transformers to apply on the PR description according to the `pr_template`
 }