README.md

Configure repositories of the Serlo GitHub organization

This repo contains the utility CLI configure-repositories that configures a repository based on predefined rules. It is used mainly for repositories of the Serlo GitHub organization.

Installation

Linux and Darwin (x86)

Download corresponding artifact file from the Releases and make it executable: chmod +x FILENAME

Windows

Download the executable (.exe) file from the Releases.

Darwin (arm64)

• Follow the steps in Development
• Build the executable depending on the Platform:
  • Darwin arm64: pipenv run build_darwin_arm64

Usage

Run ./configure_repositories with one or more paths to repositories:

./configure_repositories [OPTIONS] COMMAND REPO

Via COMMAND you can define the changes which shall be applied to the repository. Run any of the following commands to see the list of all possible commands:

./configure_repositories --help

./configure_repositories

Example: Sort the yarn scripts alphabetically

./configure_repositories sort-yarn-scripts ../api.serlo.org

Example: Configure a local MySQL database

./configure_repositories setup-local-mysql ../db-migrations

Development

• Install the Python version in .tool-versions
  • You may use asdf for the installation.

Using pipenv

• Install pipenv
• Run pipenv shell to activate the project's virtual environment.
• Run pipenv install --dev to install the dev dependencies.
• Run pipenv run lint to run the linting.
• Run pipenv run format to format the code.

Testing

• You can test the commands running python configure_repositories.py [OPTIONS] COMMAND REPO

Releases

• Change the version in setup.py
• Push a new tag with the format major.minor.patch
• The push of a new tag will trigger the creation of the releases for:
  • Linux (x86)
  • macOS (x86)
  • Windows (x86)