Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/tspascoal/stale-repos

A GitHub App built with Probot (https://github.com/probot/probot) to help you find stale repos in an easy fashion.
https://github.com/tspascoal/stale-repos

probot probot-app

Last synced: 2 days ago
JSON representation

A GitHub App built with Probot (https://github.com/probot/probot) to help you find stale repos in an easy fashion.

Host: GitHub
URL: https://github.com/tspascoal/stale-repos
Owner: tspascoal
License: isc
Created: 2020-07-21T16:32:19.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2023-03-05T08:56:10.000Z (almost 2 years ago)
Last Synced: 2024-11-02T08:51:39.714Z (about 2 months ago)
Topics: probot, probot-app
Language: TypeScript
Homepage:
Size: 1.43 MB
Stars: 3
Watchers: 2
Forks: 0
Open Issues: 22
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

# Stale Repos

> A GitHub App built with [Probot](https://github.com/probot/probot) to help you find stale repos in an easy fashion.

The bot scans your reps in regular intervals (default is once a day) and if they lack activity for a configurable amount of time they will be marked as staled.

Pushes to the repo, creating or update issues or pull requests are considered activity.

When a repository is considered stale, a [topic](https://docs.github.com/en/github/administering-a-repository/classifying-your-repository-with-topics) is added to the repository so you can easily find all stale repos by [searching](https://docs.github.com/en/github/searching-for-information-on-github/searching-topics) for repos who have the `stale`

If a repository has been marked as stale and there is activity after that the application automatically removes the stale topic as well (this is not done in real time, so it may take a few hours for the topic to be removed)

> This is just a sample application, it is not offered as a service so if you wish to use it then you need to host it yourself

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=stale-repos&metric=alert_status)](https://sonarcloud.io/dashboard?id=stale-repos) ![CI](https://github.com/tspascoal/stale-repos/workflows/CI/badge.svg)

## Setup

```sh
# Install dependencies
npm install

# Run with hot reload
npm run build:watch

# Compile and run
npm run build
npm run start
```

### Configuring the application

The application is only provided in source code form as a sample, you need to register and host it yourself.

The application can be registered manually or using the provided [application manifest](app.yml).

Learn how to register the [application](https://docs.github.com/en/developers/apps/creating-a-github-app-from-a-manifest)

> Note: The manifest marks the application as **private**, so it can be installed by the application onwer on it's own repos, if you are installing it on your own private server then it's better if you make it public.

If you are going to register the application manually these are the required permissions

* **administration** - read & write (required to manage a repo topics)
* **contents** - read
* **issues** - read
* **metadata** - read
* **pull requests** - read

#### Configuration settings

The application has the following parameters (they are configure as environment variables)

* STALE_TOPIC (optional, default value `stale`) The name of the topic that is used to mark stale repo.
* INACTIVITY_HOURS (optional, default 4320 (180 days))) The maximum time of hours a repo can be inactive until it is considered stale.
* INTERVAL_HOURS (optional, default 24 hours) - At which interval should the repo(s) be scanned (either to mark or unmark them as stale)
* GHE_HOST (optional, defaults to github.com)

#### Installation

After the application has been configured and running you will need to install it on the repo(s) or organizations that you want to check for staleness

### Learning More

If you wish to learn more about GitHub Applications you can learn more at [Getting Started with apps](https://docs.github.com/en/developers/apps/getting-started-with-apps)

## Contributing

If you have suggestions for how stale-repo could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the [Contributing Guide](CONTRIBUTING.md).

## License