Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Eomm/notification-remover

Clean your inbox notification, on the go, when you need!
https://github.com/Eomm/notification-remover

actions github github-actions notifications

Last synced: 3 months ago
JSON representation

Clean your inbox notification, on the go, when you need!

Host: GitHub
URL: https://github.com/Eomm/notification-remover
Owner: Eomm
License: mit
Created: 2021-11-28T09:05:56.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2023-01-26T16:04:59.000Z (almost 2 years ago)
Last Synced: 2024-05-01T14:41:41.365Z (7 months ago)
Topics: actions, github, github-actions, notifications
Language: JavaScript
Homepage:
Size: 459 KB
Stars: 8
Watchers: 2
Forks: 0
Open Issues: 11
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS

Awesome Lists containing this project

README

# notification-remover

Clean your inbox notification, on the go, when you need!

This GitHub Action let you to remove all the BOT notification on your inbox!
Supported bots:

- [x] [Dependabot](https://github.blog/2020-06-01-keep-all-your-packages-up-to-date-with-dependabot/)
- [ ] [Renovate](https://github.com/renovatebot/renovate)

## Installation

To allow GitHub Actions to mark as read **your** notifications, you need to create a [Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
The **only** permission needed is `notifications`.

After you have created the token, you can use it to use this GitHub Action.

1. Create a new repository. (_I suggest to use your GitHub profile repository_)[https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme]
1. Add your personal access token to the repository's secrets as `USER_TOKEN`.
1. Create a new GitHub Workflow as in the `Usage` section.

## Usage

This minimal example adds a new workflow to your repository that you can use to remove all the BOT notification on your inbox.
This simple workflow can be triggered by a `curl` command or a chron job: it is a matter of your choice!

Create a `notification-remover.yml` file in your repository.

```yml
name: notification-remover

on:
workflow_dispatch:

jobs:
notification-remover:
runs-on: ubuntu-latest
steps:
- uses: Eomm/notification-remover@v1
with:
github-user-token: ${{ secrets.USER_TOKEN }}
```

Than you will be able to trigger the workflow by a `curl` command:

```sh
# https://docs.github.com/rest/reference/actions#create-a-workflow-dispatch-event
curl -X POST \
-H "Accept: application/vnd.github.v3+json" \
-H "Authorization: token {workflow_user_token}" \
https://api.github.com/repos/{owner}/{reponame}/actions/workflows/notification-remover.yml/dispatches \
-d '{"ref":"main"}'
```

> Note that the `workflow_user_token` is a new GitHub Personal Access Token with the `workflow` permission.

A more complete workflow can be as follow:

```yml
name: notification-remover

on:
workflow_dispatch:
inputs:
days-ago:
default: 5
pr-state:
default: 'all'

jobs:
notification-remover:
runs-on: ubuntu-latest
steps:
- uses: Eomm/notification-remover@v1
with:
github-user-token: ${{ secrets.USER_TOKEN }}
pr-state: ${{ github.event.inputs.pr-state }}
days-ago: ${{ github.event.inputs.days-ago }}
```

Give it a try!

### Arguments

| Name | Default | Description |
| ---- | ------- | ----------- |
| `github-user-token` | - | (required) Personal access token to use to access GitHub. |
| `days-ago` | `5` | Number of days to look back for notifications. |
| `pr-state` | `closed` | Mark as read the notification only if the PR is in the selected stage. Possible values: `closed`, `open`, `all` |

## Development this Action

Read the [developer documentation](https://github.com/actions/javascript-action#package-for-distribution).

## License