bambooom / gh-noti

gh extension to check unread notifications

gh-noti

Github CLI extension to check unread notifications in this page.

As the feature is available in gh, see this issue.

Still WIP.

Installation

gh extension install bambooom/gh-noti

Needs jq installed

brew install jq

Usage

1. gh noti : list all unread notifications

ID          Repo                         Type         Title                                                                                                 Reason            Updated
-------     ------                       -------      ---------------                                                                                       ------            -------------------
2371625702  zzzzc/openresty-doc          PullRequest  fix markdown toc sidebar                                                                              author            2021-09-03T05:56:14Z
1209817679  mengxiong10/vue2-datepicker  Issue        Vue3 compatibility                                                                                    manual            2021-08-27T20:05:51Z
535892525   axios/axios                  Issue        Handling onUploadProgress on network failure                                                          manual            2021-07-27T07:15:54Z

Or no unread:

✨ No unread notifications.

2. gh noti read: mark all notifications as read

3. gh noti read <id>: use the id in the list to mark one thread as read

Todo

• mark all as read, https://docs.github.com/en/rest/reference/activity#mark-notifications-as-read
• mark one as read by id, https://docs.github.com/en/rest/reference/activity#mark-a-thread-as-read
• open a unread notification thread url

Ref

• GitHub CLI 2.0 includes extensions! | The GitHub Blog
• Creating GitHub CLI extensions - GitHub Docs
• no API for marking a notification as 'Done' status as it seems relatively new and maybe changed later, see https://github.community/t/no-api-command-for-new-done-state-of-notifications/122508

gh-noti's Issues

Add support for secure token storage

Token storage change in latest release of gh

This is a message from the GitHub CLI team, maintainers of gh, writing to inform you that the most recent release of gh contains changes which may affect your extension. The latest release introduces the feature of storing authentication tokens in the system keyring (encrypted storage) instead of in a plain text file.
The keyrings that are supported are:

• Keychain on macOS

• GNOME Keyring on Linux (Secret Service dbus interface)

• Wincred on Windows

This has huge security benefits for the users of our tool and was one of our oldest outstanding issues. Unfortunately this change has the potential to break extensions that rely on utilizing the users authentication token to work.

In order to have continued compatibility with gh there are some actions you, as an extension author, need to take. These actions will depend on the implementation of your extension.

Extensions built in Go using go-gh:

1. Upgrade your go-gh version to v1.2.1, the latest version.

   • This can be done using go get github.com/cli/[email protected]

2. Verify that in your extension retrieval of the user authentication token is done using the auth.TokenForHost function.

   • If you were previously accessing the authentication token using any other method it will no longer work.
   • Automatic resolution of the authentication token when using the API clients will continue to work without changes.

All other extensions:

1. Verify that in your extension retrieval of the user authentication token is done by shelling out to the gh auth token command.

   • If you were previously accessing the authentication token using the gh config get command, reading the configuration file directly, or any other methods it will no longer work.

As of right now storing the authentication token in the system keyring is an opt-in feature, but in the near future it will be required and at that point if the changes above are not made then your extension will be broken for all users. If you have any questions/concerns about this change please feel free to open a discussion in the gh repo.

Thanks,
The GitHub CLI Team