https://github.com/klaasnicolaas/github-config
Centralised config for all my GitHub repos 🛠️
https://github.com/klaasnicolaas/github-config
config github hacktoberfest sync
Last synced: about 1 year ago
JSON representation
Centralised config for all my GitHub repos 🛠️
- Host: GitHub
- URL: https://github.com/klaasnicolaas/github-config
- Owner: klaasnicolaas
- License: mit
- Created: 2023-06-01T12:13:44.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-08T22:44:35.000Z (about 2 years ago)
- Last Synced: 2024-05-11T22:45:31.359Z (about 2 years ago)
- Topics: config, github, hacktoberfest, sync
- Homepage:
- Size: 153 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Config
A centralized place for config files used in many GitHub repositories 🛠️
## Why?
If you have a lot of repositories, a small adjustment becomes a huge job to update this everywhere. This process is partly automated with this approach and in the end you only have work on merging the pull requests.
## How it works
* Common config files are kept in this repository
* When a release is published in this repo, the [Repo File Sync] action is triggered
* PR's are raised in the target repos with the changes, defined in [sync.yml](.github/sync.yml)
## Setting up development environment
This Python project is fully managed using the [Poetry][poetry] dependency
manager.
You need at least:
- Python 3.11+
- [Poetry][poetry-install]
### Installation
Install all packages, including all development requirements:
```bash
poetry install
```
_This project will be installed in non-package mode._
### Pre-commit
This repository uses the [pre-commit][pre-commit] framework, all changes
are linted and tested with each commit. To setup the pre-commit check, run:
```bash
poetry run pre-commit install
```
And to run all checks and tests manually, use the following command:
```bash
poetry run pre-commit run --all-files
```
[Repo File Sync]: https://github.com/marketplace/actions/repo-file-sync-action
[copier]: https://copier.readthedocs.io/en/stable/
[poetry-install]: https://python-poetry.org/docs/#installation
[poetry]: https://python-poetry.org
[pre-commit]: https://pre-commit.com