Ready for production

app.py

@@ -21,7 +21,7 @@ def get_release_notes(
     ignore_direct: bool,
 ):
     date = get_tag_commit_date(token, repo, tag)
-    commits = get_commits(token, repo, date)
+    commits = get_commits(token, repo, branch, date)
 
     result = ""
     contributors = {}
@@ -52,7 +52,7 @@ def get_release_notes(
             result += f"* {commit.message} by @{commit.user.name} (direct commit on {branch})\n"
 
     significant_contributors = {
-        k: v for k, v in contributors.items() if (v.additions + v.deletions) > contributor_treshold
+        k: v for k, v in contributors.items() if (v.additions + v.deletions) > contributor_treshold and k != '<NOT FOUND>'
     }
 
     if len(significant_contributors):
@@ -69,6 +69,38 @@ def get_release_notes(
 
     return result
 
+article = """
+## How to use the interface?
+
+⚠️ Most errors are due to:
+- A wrong `tag` -> the tag must exist on the repository!
+- A wrong `branch` -> The branch must exist on the repository!
+- A wrong `token` -> Obtaining a token is detailed below.
+
+### token
+
+This is a personal access token generated by GitHub. You can obtain one with the following guide:
+https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token.
+
+### Repository
+
+The repository for which to create the release notes. Should be in the format '<organization>/<repository>'.
+
+### Tag
+
+The tag from which all commits were made. The app will fetch the date at which this tag was created, and will
+return all commits of the branch defined below that have a timestamp following that date.
+
+### Branch
+
+The branch on which all commits lie. Usually `master` or `main`.
+
+### Threshold
+
+This threshold allows highlighting specific community contributors according to the size of their contributions.
+It currently adds all their additions/deletions across all PRs included in this release. It is then compared
+to the defined threshold: if above, that user will get a special note mentioning what they have worked on!
+"""
 
 demo = gr.Interface(
     fn=get_release_notes,
@@ -93,8 +125,16 @@ demo = gr.Interface(
         gr.inputs.Checkbox(label="Ignore direct commits"),
     ],
     outputs="text",
+    examples=[
+        ['ghp_XXX', 'huggingface/datasets', '2.1.0', 'master', 60, True, True],
+        ['ghp_XXX', 'huggingface/accelerate', 'v0.7.1', 'main', 500, True, True],
+        ['ghp_XXX', 'huggingface/transformers', 'v4.18.0', 'main', 500, True, True],
+        ['ghp_XXX', 'gradio-app/gradio', 'v2.9.0', 'main', 500, True, True],
+    ],
+    title='Automatic release notes 🤗',
+    article=article
 )
 
 
 if __name__ == "__main__":
-    demo.launch()
+    demo.launch(show_error=True)

graphql_calls.py

@@ -46,7 +46,7 @@ def get_tag_commit_date(token, repository, tag):
     return call_with_query(query, token)['data']['repository']['object']['committedDate']
 
 
-def get_commits(token, repository, since):
+def get_commits(token, repository, branch, since):
     owner, name = repository.split('/')
 
     def get_page_result(next_page=''):
@@ -54,7 +54,7 @@ def get_commits(token, repository, since):
         query GetCommits {{
             repository(owner: "{owner}", name: "{name}"){{
                 nameWithOwner
-                object(expression: "main") {{
+                object(expression: "{branch}") {{
                     ... on Commit {{
                         oid
                         history(first: 100, since: "{since}"{next_page}) {{
@@ -84,6 +84,10 @@ def get_commits(token, repository, since):
         }}
         """
         result = call_with_query(query, token)
+
+        if result['data']['repository']['object'] is None:
+            raise ValueError("Either the tag or the branch were incorrect.")
+
         nodes = result['data']['repository']['object']['history']['nodes']
         cursor = result['data']['repository']['object']['history']['pageInfo']['endCursor']
         return nodes, cursor