Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mateodelnorte/meta-project
https://github.com/mateodelnorte/meta-project
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mateodelnorte/meta-project
- Owner: mateodelnorte
- License: mit
- Created: 2016-12-26T18:00:06.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-03-19T03:20:10.000Z (8 months ago)
- Last Synced: 2024-04-13T16:33:20.502Z (7 months ago)
- Language: JavaScript
- Size: 313 KB
- Stars: 6
- Watchers: 3
- Forks: 16
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.com/mateodelnorte/meta-project)
# meta-project
project plugin for [meta](https://github.com/mateodelnorte/meta)
## Usage
```
Usage: meta project []
Commands:
create create and initialize a new child repository
import import an existing child repository via git clone
migrate migrate from a monorepo to a metarepo
help display help for
Options:
-h, --help output usage information
```
## Creating a new project
To create a new project, use `meta project create `
```
meta project create new-dir [email protected]/org/repo
```
## Import an existing project
To import an existing project, use `meta project import []`
```
meta project import projects/example [email protected]/your-org/example
```
To import existing project which is already checked out at ``, `` can be omitted
```
meta project import projects/example
```
## Migrate a Monorepo to a metarepo and keep your git history intact.
'meta project migrate' helps you move from a monorepo to a meta repo by moving directories from
your existing repo into separate child repos, with git history intact. These are then referenced in
your '.meta' file and cloned, making the operation transparent to your codebase.
For example, given the following monorepo structure:
```
- monorepo-base
- project-a
- project-b
- project-c
```
Create git repos for `project-a`, `project-b`, and `project-c`, then run:
```
cd monorepo-base
meta init
meta project migrate project-a [email protected]/yourorg/project-a
meta project migrate project-b [email protected]/yourorg/project-b
meta project migrate project-c [email protected]/yourorg/project-c
```
This will keep the git history of each subproject in tact, using some git magic:
- Explanation: https://help.github.com/en/articles/splitting-a-subfolder-out-into-a-new-repository
- Implementation: https://github.com/mateodelnorte/meta-project/blob/master/lib/splitSubtree.js
## How it works
A) Migrate will first create a copy of your project in a temporary directory and replace the remote
'origin' with the provided
B) It will split the history from and push to the provided :
https://help.github.com/en/articles/splitting-a-subfolder-out-into-a-new-repository
C) Next is removed from your monorepo, and then cloned back into the same location.
In the eyes of the monorepo, the only thing that has changed is the .meta file, however,
now also has it's own distinct history.
## Migration Phase
If you need the monorepos structure to stay in tact for any extended duration, such as supporting legacy CI
systems, you can stop here.
While in this 'migration' phase, you need to commit to the child directory's git history as well as the
monorepo's git history. These commits can literally be made twice by cd-ing around or both can be made
at once using 'meta git commit'.
## Finishing the Migration
When the monorepo no longer needs to be maintained you can simply add the migrated project to your '.gitignore'.
This will cause changes to only be tracked in the child repo, rather than both, such as during the migration phase.