https://github.com/datalayer/metarepo

Ξ Metarepo useful to developer the Datalayer repositories.
https://github.com/datalayer/metarepo

datalayer git metarepo

Last synced: about 5 hours ago
JSON representation

Ξ Metarepo useful to developer the Datalayer repositories.

• Host: GitHub
• URL: https://github.com/datalayer/metarepo
• Owner: datalayer
• Created: 2023-12-16T17:22:26.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-04-22T05:55:28.000Z (7 months ago)
• Last Synced: 2024-04-22T06:44:54.167Z (7 months ago)
• Topics: datalayer, git, metarepo
• Language: Jinja
• Homepage: https://datalayer.tech
• Size: 472 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Datalayer](https://assets.datalayer.tech/datalayer-25.svg)](https://datalayer.io)

[![Become a Sponsor](https://img.shields.io/static/v1?label=Become%20a%20Sponsor&message=%E2%9D%A4&logo=GitHub&style=flat&color=1ABC9C)](https://github.com/sponsors/datalayer)

# Ξ Metarepo template for Datalayer

This repository serves as a [Copier](https://copier.readthedocs.io/en/stable/) template designed to generate a scaffolding project that allows to simultaneously develop on multiple repositories. This **metarepo** will, then, allow you to clone a list of independent repositories under the `package` folder and will create with [Lerna.js](https://lerna.js.org) the needed links so a change in `repository x` will be visible by `repository y`.

This is particularly useful for JavaScript and TypeScript based projects, and we use it at Datalayer to simultaneously develop on many JupyterLab extensions (mixed Typescript and Python repositories).

> [!NOTE]  

> While the current version does not include features related to `git submodule`, ongoing discussions about this enhancement can be found [here](https://github.com/datalayer/metarepo/issues/2).

## Usage

The following section provides a step-by-step guide on how to generate your scaffolding project.

### Install Copier

Ensure that Copier (`copier` and `copier-templates-extensions`) is correctly installed by following the instructions in the [official documentation](https://copier.readthedocs.io/en/stable/#installation). You will e.g. pip install the packages with the following command.

```bash

pip install copier copier-templates-extensions

```

### Generate the metarepo structure

Generate the project using the command provided below. Be sure to replace `` with your chosen project location.

```bash

copier copy --trust https://github.com/datalayer/metarepo.git 

```

This command initiates a series of prompts to configure the project based on your preferences.

### Finalize

Complete the setup of your scaffolding project by referring to the instructions outlined in the README of the newly generated project.

Happy metarepo! 🚀