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

https://github.com/beam-community/common-config

A repository containing shared configuration for all of our Elixir projects
https://github.com/beam-community/common-config

config elixir linting standardization

Last synced: 3 months ago
JSON representation

A repository containing shared configuration for all of our Elixir projects

Awesome Lists containing this project

README

          

# Common Config

This repository contains shared code for all of our Elixir repositories. This includes configuration files for credo, dialyzer, formatting, and github actions. It syncs all files to repositories on a file change to this repository.

Currently at version `1.16.1`

## Directories

- `scripts` contains javascript and elixir scripts that are ran on each repository. These could be as simple as copying a file to the repository, or as advanced as changing the `mix.exs` AST to update dependencies.

- `templates` contains files that are copied or templated to the repository.

## Usage

- Copy [./templates/.github/workflows/common-config.yaml](./templates/.github/workflows/common-config.yaml) file into your repo's `/.github/workflows/` directory.
- Alter your common-config.yaml file by replacing `$\{{` with `${{`.
- Create a PR.
- On initial merge and on a [recurring schedule](./templates/.github/workflows/common-config.yaml#L15), updates will be synced with this repository.