https://github.com/openfun/fun-config
:sparkles: Misc FUN configuration files
https://github.com/openfun/fun-config
Last synced: 3 months ago
JSON representation
:sparkles: Misc FUN configuration files
- Host: GitHub
- URL: https://github.com/openfun/fun-config
- Owner: openfun
- License: mit
- Created: 2018-04-23T16:09:46.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2021-05-06T09:48:13.000Z (almost 5 years ago)
- Last Synced: 2025-08-11T05:34:40.269Z (9 months ago)
- Language: Makefile
- Homepage:
- Size: 16.6 KB
- Stars: 2
- Watchers: 9
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ✨ FUN Config ✨
This repository is the place where we store various configuration files shared
among the FUN development team.
## GitHub Labels
Inspired by TailorDev's work on [communication with GitHub
issues](https://tailordev.fr/blog/2016/09/27/communication-with-github-issues-1/),
we decided to define our own set of labels that will be used in all our GitHub
repositories to improve and normalize our work on issues and PRs for both
internal and external contributors. In this section, we will document how to
install and use the [`labels`](https://github.com/popomore/github-labels) tool
to automate labels creation for a GitHub repository.
### Getting started with `labels`
#### GitHub personal access token
To interact with the GitHub API, you will need to [generate a personal access
token](https://github.com/settings/tokens) (make sure it has the `repo`
permission).
Once generated, we will store this token in an environment variable that will be
defined in your favorite shell rc file:
```bash
# .bashrc or .zshrc
export GITHUB_LABELS_TOKEN="thisismytoken"
```
Load a new shell or source your rc file to take into account this new
environment variable (_e.g._ `source $HOME/.zshrc`).
#### Build the `fun-config` Docker image
```bash
$ make build
```
### Create default labels for a repository
Once the `fun-config` image has been successfully built, you can use our default
labels configuration to initialize labels from a repository:
```bash
$ bin/labels user/repository
```
Feel free to substitute `user` by the project namespace (_e.g._ your user name
or team) and repository by the name of the repository.
## License
This work is released under the MIT License (see [LICENSE](./LICENSE)).