node-reposync v2.0.1

node-reposync

Helper NPM package for syncing base project with multiple repos.

This nodejs module was created to substitute repo tool required to download and update multiple repositories while working with Yocto-based projects.

It also allows to use nodejs package.json to manage build scripts for your Yocto-based project.

Quick start

Existing project

1. Install module as developer dependency:

npm install node-reposync --save-dev
# or if you usually yarn:
yarn add node-reposync --dev

2. Add repos and reposDir to your package.json

• repos is stores all repos that needs to be synchronized;
• reposDir defines a directory where all repos will be synchronized;

For example:

{
	"reposync": {
		"repos": {
			"meta-openembedded": {
				"url": "https://github.com/openembedded/meta-openembedded.git",
				"branch": "kirkstone",
				"depth": 1
			}
		},
		"dir": "sources"
	}
}

4. Add script to your package.json

{
	"scripts": {
		"sources": "reposync"
	}
}

5. Run invocation script

npm run sources

New project

1. Create package.json for parent project

First, lets create package.json:

npm init

Second, add repos and/or reposDir to package.json.

Minimal package.json should have this:

{
	"reposync": {
		"repos": {
			"meta-openembedded": {
				"url": "https://github.com/openembedded/meta-openembedded.git"
			}
		}
	}
}

Practical package.json can have also branch names and depth levels, alone with directory where repos will be synchronized:

{
	"reposync": {
		"repos": {
			"meta-openembedded": {
				"url": "https://github.com/openembedded/meta-openembedded.git",
				"branch": "kirkstone",
				"depth": 1
			}
		},
		"dir": "sources"
	}
}

2. Invocation from parent project

Javascript:

// sources.js
var Reposync = require('node-reposync');
var sync = new Reposync.Sync();
console.log(sync.doSync({}));

Or if you prefer Typescript (you will need to enable Typescript support to run this):

import { Sync } from 'node-reposync';
new Sync().doSync({});

Full working example

For this example you will need nodejs and NPM installed.

0. Install required tools

Ubuntu

This will also install nodejs

sudo apt install -y npm

Other OSes

Please refer to this link:

https://docs.npmjs.com/downloading-and-installing-node-js-and-npm

1. package.json

Create package.json in root directory of your project.

{
	"name": "your-distro",
	"version": "0.0.1",
	"description": "",
	"scripts": {
		"sources": "node sources.js"
	},
	"dependencies": {
		"node-reposync": "^0.0.5"
	},
	"reposync": {
		"dir": "sources",
		"repos": {
			"poky": {
				"url": "git://git.yoctoproject.org/poky",
				"branch": "kirkstone",
				"depth": 1
			},
			"meta-openembedded": {
				"url": "https://github.com/openembedded/meta-openembedded.git",
				"branch": "kirkstone",
				"depth": 1
			},
			"openembedded-core": {
				"url": "git://git.openembedded.org/openembedded-core",
				"branch": "kirkstone",
				"depth": 1
			}
		}
	}
}

2. sources.js

Create sources.js in root directory of your project.

// sources.js
var Reposync = require('node-reposync');
var sync = new Reposync.Sync();
console.log(sync.doSync({}));

3. Initialize NPM

Run in terminal from root directory of your project.

npm install

4. Run

Now you can run sources sync script. It will git clone or git fetch into specified rootDir, depending on existence of repo directory.

npm run sources