Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/darsan-in/github-admin
Github-Admin is a streamlined collection of boilerplate code designed for performing CRUD operations on GitHub repositories. Utilizing the power of the @octokit/rest library, it simplifies tasks like creating, updating, and deleting repositories through the GitHub REST API, making repository management more efficient for developers.
https://github.com/darsan-in/github-admin
access-control automated-workflows ci-cd-pipelines crud-operations github github-actions github-api github-repositories github-rest-api octokit permissions repository-management rest-api team-management
Last synced: about 2 months ago
JSON representation
Github-Admin is a streamlined collection of boilerplate code designed for performing CRUD operations on GitHub repositories. Utilizing the power of the @octokit/rest library, it simplifies tasks like creating, updating, and deleting repositories through the GitHub REST API, making repository management more efficient for developers.
- Host: GitHub
- URL: https://github.com/darsan-in/github-admin
- Owner: darsan-in
- License: apache-2.0
- Created: 2024-08-03T21:44:55.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-11-10T07:36:52.000Z (3 months ago)
- Last Synced: 2024-12-06T09:58:42.670Z (2 months ago)
- Topics: access-control, automated-workflows, ci-cd-pipelines, crud-operations, github, github-actions, github-api, github-repositories, github-rest-api, octokit, permissions, repository-management, rest-api, team-management
- Language: JavaScript
- Homepage:
- Size: 50.8 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Github-Admin: Collection of GitHub CRUD Boilerplate Code
Github-Admin is a streamlined collection of boilerplate code designed for performing CRUD operations on GitHub repositories. Utilizing the power of the @octokit/rest library, it simplifies tasks like creating, updating, and deleting repositories through the GitHub REST API, making repository management more efficient for developers.
### Supported Platforms
[]()
[]()
[]()
---
---
---
---
## Table of Contents 📝
- [Features and Benefits](#features-and-benefits-)
- [Use Cases](#use-cases-)
- [Friendly request to users](#-friendly-request-to-users)
- [Installation - Step-by-Step Guide](#installation---step-by-step-guide-)
- [Usage](#usage)
- [License](#license-%EF%B8%8F)
- [Contributing to Our Project](#contributing-to-our-project-)
- [Contact Information](#contact-information)
- [Credits](#credits-)
## Features and Benefits ✨
- **Easy Repository Creation**: Quickly set up new repositories with minimal configuration.
- **Effortless Updates**: Seamlessly update repository details such as name, description, and visibility.
- **Repository Deletion**: Safely delete repositories you no longer need.
- **Listing Repositories**: Retrieve a comprehensive list of repositories associated with your GitHub account.
- **File Management**: Create, read, and delete files within a repository effortlessly.
- **Secret Management**: Securely manage and add secrets to repositories.
- **Workflow Automation**: Trigger workflows and manage permissions for GitHub Actions.
## Use Cases ✅
- **Automated Repository Management**: Integrate Github-Admin into CI/CD pipelines to automate repository setup and teardown.
- **Project Bootstrapping**: Quickly create and configure repositories for new projects.
- **Repository Cleanup**: Automate the deletion of obsolete or unused repositories.
- **Bulk Updates**: Efficiently apply updates to multiple repositories in one go.
- **GitHub Organization Management**: Manage repositories within GitHub organizations with ease.
- **Custom Tools Development**: Use Github-Admin as a foundation for building custom GitHub management tools.
---
### 🙏🏻 Friendly Request to Users
Every star on this repository is a sign of encouragement, a vote of confidence, and a reminder that our work is making a difference. If this project has brought value to you, even in the smallest way, **please consider showing your support by giving it a star.** ⭐
_"Star" button located at the top-right of the page, near the repository name._
Your star isn’t just a digital icon—it’s a beacon that tells us we're on the right path, that our efforts are appreciated, and that this work matters. It fuels our passion and drives us to keep improving, building, and sharing.
If you believe in what we’re doing, **please share this project with others who might find it helpful.** Together, we can create something truly meaningful.
Thank you for being part of this journey. Your support means the world to us. 🌍💖
---
## Installation - Step-by-Step Guide 🪜
- **Step 1:** Clone this repo.
```bash
git clone https://github.com/darsan-in/Github-Admin.git
```
- **Step 2:** Install Node JS if not installed already. Follow this page https://nodejs.org/en/download/package-manager/current
- **Step 3:** Create [personal access token](https://github.com/settings/tokens) and save it in system environment variable as `GITHUB_TOKEN`.
- **Step 4:** Open terminal execute this command
```bash
npm install
```
- **Step 5:** Now you can run program of your choice.
## Usage
- **Triggering action On all repository simultaneously.**
```js
async function main() {
const repoNames = listRepoRemote();
const ignoreList = [".github"];
let actionCount = 0;
for (const owner of Object.keys(repoMeta)) {
for (const repoName of repoMeta[owner]) {
if (!ignoreList.includes(repoName.toLowerCase())) {
try {
await triggerWorkflow(owner, repoName);
actionCount += 1;
} catch (err) {
console.log(err);
}
}
}
}
console.log("Action triggerd on ", actionCount, "repos");
}
```
- **Add secret to all your repository simultaneously.**
```js
async function main() {
const groupedRepolists = await listRepoRemote();
Object.keys(groupedRepolists).forEach((username) => {
groupedRepolists[username].forEach((repoName) => {
addSecret(username, repoName);
});
});
}
main();
```
## License ©️
This project is licensed under the [Apache License 2.0](LICENSE).
## Contributing to Our Project 🤝
We’re always open to contributions and fixing issues—your help makes this project better for everyone.
If you encounter any errors or issues, please don’t hesitate to [raise an issue](../../issues/new). This ensures we can address problems quickly and improve the project.
For those who want to contribute, we kindly ask you to review our [Contribution Guidelines](CONTRIBUTING) before getting started. This helps ensure that all contributions align with the project's direction and comply with our existing [license](LICENSE).
We deeply appreciate everyone who contributes or raises issues—your efforts are crucial to building a stronger community. Together, we can create something truly impactful.
Thank you for being part of this journey!
## Contact Information
For any questions, please reach out via [email protected] or [LinkedIn](https://www.linkedin.com/in/darsan-in/).
## Credits 🙏🏻
Special thanks to [Keegan Campbell](https://github.com/kfcampbell), [Nick Floyd](https://github.com/nickfloyd), [Gregor Martynus](https://github.com/gr2m) and all maintainers of @octokit/rest for their contributions to the underlying foundation library.
---
---
#### Topics
- github
- repository management
- crud operations
- octokit
- rest api
- github api
- ci/cd pipelines
- github actions
- automated workflows
- team management
- access control
- permissions
- github repositories
- github rest api