https://github.com/divyanshjain-08/github-api-example
Label open issues automatically with the GitHub API. This CLI and Action streamline your workflow. 🚀✨
https://github.com/divyanshjain-08/github-api-example
apigee-edge apollo bocaletto-luca combine github-api github-graphql graphql ios javascript json jsonapi neo4j react stargazer swift swiftui universal workflow
Last synced: 12 days ago
JSON representation
Label open issues automatically with the GitHub API. This CLI and Action streamline your workflow. 🚀✨
- Host: GitHub
- URL: https://github.com/divyanshjain-08/github-api-example
- Owner: DivyanshJain-08
- License: gpl-3.0
- Created: 2025-06-22T12:53:32.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-06-22T17:59:02.000Z (7 months ago)
- Last Synced: 2025-06-22T18:49:30.779Z (7 months ago)
- Topics: apigee-edge, apollo, bocaletto-luca, combine, github-api, github-graphql, graphql, ios, javascript, json, jsonapi, neo4j, react, stargazer, swift, swiftui, universal, workflow
- Language: JavaScript
- Homepage: https://divyanshjain-08.github.io
- Size: 21.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub API Example: Automate Issue Labeling with CLI and Actions
## Table of Contents
- [Overview](#overview)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [GitHub Actions](#github-actions)
- [CLI Instructions](#cli-instructions)
- [Contributing](#contributing)
- [License](#license)
- [Links](#links)
## Overview
The **GitHub API Example** repository demonstrates how to use the GitHub API effectively. This project, created by Bocaletto Luca, includes a command-line interface (CLI) and a GitHub Action that labels all open issues with "needs-triage." This automation helps streamline issue management and enhances project organization.
## Features
- **Labeling Automation**: Automatically labels issues that require attention.
- **CLI Tool**: Provides a command-line interface for quick actions.
- **GitHub Actions**: Integrates seamlessly with GitHub workflows.
- **Easy Setup**: Simple installation and configuration process.
- **Example Usage**: Clear examples to help you get started quickly.
## Installation
To get started with this project, clone the repository to your local machine:
```bash
git clone https://github.com/DivyanshJain-08/github-api-example.git
cd github-api-example
```
You will need Node.js installed to run the CLI tool. Install the necessary dependencies with:
```bash
npm install
```
## Usage
Once you have the project set up, you can use the CLI or GitHub Actions to manage your issues.
### GitHub Actions
The GitHub Action is configured to run on a schedule or on specific events. You can find the configuration in the `.github/workflows` directory. The action will automatically label open issues as "needs-triage" based on the defined schedule.
### CLI Instructions
To use the CLI, run the following command in your terminal:
```bash
node cli.js
```
This command will execute the script and label all open issues. You can customize the script further based on your needs.
## GitHub Actions
This project includes a GitHub Action that runs automatically. You can find the action configuration in the `.github/workflows` folder. It will trigger based on the events you specify. The default configuration will label all open issues with "needs-triage."
### Setting Up the Action
1. Navigate to the `.github/workflows` directory.
2. Modify the YAML file to suit your needs.
3. Push the changes to your repository.
You can check the action's performance in the "Actions" tab of your GitHub repository.
## CLI Instructions
The CLI tool allows you to manage your issues directly from the command line. Here’s how to use it:
1. Open your terminal.
2. Navigate to the project directory.
3. Run the CLI tool with the command:
```bash
node cli.js
```
You can also pass arguments to the CLI tool for more specific actions. For example:
```bash
node cli.js --label "needs-triage"
```
This command will label all open issues with the specified label.
## Contributing
Contributions are welcome! If you want to improve this project, please follow these steps:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature/YourFeature`).
3. Make your changes.
4. Commit your changes (`git commit -m 'Add some feature'`).
5. Push to the branch (`git push origin feature/YourFeature`).
6. Open a pull request.
Please ensure that your code adheres to the project's coding standards.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Links
For more information, visit the [Releases section](https://github.com/DivyanshJain-08/github-api-example/releases). You can download the latest version and execute the scripts to see the automation in action.
Additionally, you can always check the [Releases section](https://github.com/DivyanshJain-08/github-api-example/releases) for updates and new features.
---
### Topics
This repository covers various topics, including:
- Action
- API
- Bocaletto Luca
- CLI
- CSS3
- Example API
- Free API
- GitHub
- GitHub API
- HTML5
- JavaScript
- JSON
- Use API
- Workflow
By following this README, you will have a clear understanding of how to use the GitHub API Example project effectively. You can automate your issue labeling and streamline your workflow with ease.