Skip to content

Latest commit

 

History

History
188 lines (149 loc) · 5.99 KB

README.md

File metadata and controls

188 lines (149 loc) · 5.99 KB
Raw

Repoverse version license

📖 Table of Contents

🌐 Overview

Repoverse automates code synchronization across multiple repositories by propagation of relevant commits, ensuring consistency and saving you time. It's most suitable for distributed systems and microservices where some part of the code needs to be synced.

⭐ Key Features

  • Automated synchronization: Propagates commits across all configured repositories, keeping them up-to-date.
  • Flexible usage: Works as a GitHub Action or directly in your Node.js applications.
  • Precise control: Synchronize specific paths and branches within repositories.
  • Seamless integration: Integrates effortlessly into your development workflows.
  • Collaborative synchronization: Raises pull requests for review and approval, ensuring code quality and alignment.

📚 Prerequisites

  • Node.js (version 14 or higher)
  • npm (or another package manager)
  • A GitHub personal access token with access to all the repositories

⚙️ Configuration

Repoverse requires a configuration object to specify the repositories to sync and other settings. Here's an example:

{
  "repositories": [
    {
      "owner": "example-user",
      "repo": "repo-to-sync-1",
      "path": "models/",
      "branch": "dev",
      "reviewers": ["Maintainer1"]
    },
    {
      "owner": "example-user",
      "repo": "repo-to-sync-2",
      "path": "models/",
      "branch": "dev",
      "reviewers": ["Maintainer2"]
    }
  ],
  "syncBranchPrefix": "sync-branch",
  "accessToken": "ghp_YourGitHubPersonalAccessTokenHere"
}

📦 Installation

To install repoverse, run the following command:

npm install repoverse

🚀 Usage

repoverse can be used in two different ways:

As a GitHub Action

Automate synchronization based on GitHub push events:

  • Create a workflow file (e.g., .github/workflows/sync.yml) in your repository.
  • Define the workflow, including triggers, jobs, and steps.
  • Use the repoverse action within your job to perform synchronization.

Example workflow:

  • Make sure that the REPOVERSE_CONFIG secret is created in your repository's settings, containing the synchronization configuration in JSON format.
name: Repository Sync

on:
  push:
    branches:
      - dev
    paths:
      - 'path/to/sync/**'

jobs:
  repoverse:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/setup-node@v1
        with:
          node-version: '20'
      - run: npm install repoverse
      - name: Run repoverse synchronization
        env:
          REPOVERSE_CONFIG: ${{ secrets.REPOVERSE_CONFIG }}
          COMMITS: ${{ toJson(github.event.commits) }}
          REPOSITORY: ${{ github.repository }}
        run: |
          echo "Running repoverse synchronization..."
          node -e "
            const Repoverse = require('repoverse');
            const config = JSON.parse(process.env.REPOVERSE_CONFIG);
            const repoverse = new Repoverse(config);
            const commits = JSON.parse(process.env.COMMITS); 
            const repository = process.env.REPOSITORY;

            repoverse.synchronize(repository, commits)
              .then(() => console.log('Repositories synchronized successfully'))
              .catch(error => console.error('Synchronization failed:', error));
          "

Programmatically in Your Code

Synchronize code on-demand or with more control:

  • Import the Repoverse module in your Node.js application.
  • Create a configuration object specifying repositories and settings.
  • Instantiate a Repoverse instance with the configuration.
  • Use the synchronize method to trigger synchronization.
const Repoverse = require('repoverse');

// Construct a configuration object for your repositories and settings
const config = {
  // your config here
};

const repoverse = new Repoverse(config);

// Source repository should be in the 'owner/repo' format and present in the config's repositories list
const sourceRepo = 'your-organization/source-repo';
const commits = [
  // Your array of commit objects to synchronize
  {
    author: {
      email: '[email protected]',
      name: 'Author Name',
      username: 'authorusername',
    },
    committer: {
      email: '[email protected]',
      name: 'Committer Name',
      username: 'committerusername',
    },
    distinct: true,
    id: 'def1234567890abcdef1234567890abcdef',
    message: 'Update models',
    timestamp: '2023-04-14T13:34:56Z',
    tree_id: 'def123456abc7890def123456abc7890def12345',
    url: 'https://github.com/example-user/repo-to-sync-1/commit/def1234567890abcdef1234567890abcdef',
  },
];

repoverse
  .synchronize(sourceRepo, commits)
  .then(() => console.log('Synchronization successful'))
  .catch(error => console.error('Synchronization failed:', error));

🔄 Workflow

  • Repoverse identifies changes in a source repository(one of the repo in config).
  • Creates corresponding branches (prefixed with a configured value) in target(reamining) repositories.
  • Applies the changes to those branches and commits them.
  • Raises pull requests in the target repositories, inviting review and approval before merging.

🤝 Contributing

Contributions to repoverse are highly encouraged! If you have a suggestion, fix, or enhancement, please open an issue or a pull request. Help us make repository synchronization seamless for developers.

📄 License

Repoverse is licensed under the MIT License.