Mayan speeds up multi-repository workflows by providing commands that manage all repositories in the workspace at once. Compared to monorepos, Mayan fully embraces a poly-repository environment. It significantly reduces the overhead of adding changes to a large number of repositories and allows for a more streamlined workflow.

Mayan is specifically designed for NPM packaged projects. Mayan currently relies on NPM Workspace for linking (Yarn support to come).

NB! Currently, mayan does not yet calculate the dependency graph for the workspace, so it will not recursively version up affected packages. Therefore, NPM package versioning and publishing should still be done manually.

• Installation
• Setup
• Commands
• Usage
• Roadmap and issues

npm install -g mayan

Define your repositories in .mayan.js in the root of your workspace

module.exports = {
    repositories: [
        // Microservice applications in apps/
        {
            url: "[email protected]:example-org-name/example-microservice-name.git",
            branch: "main",
            path: "apps/microservice-service"
        },

        // Shared package libraries in packages/
        {
            url: "[email protected]:example-org-name/example-package-name.git",
            branch: "main",
            path: "packages/package-name",
        }
    ]
}

In the workspace root: npm init

This will create a package.json file in the root of your workspace. It is mainly used to define the "workspace" paths for npm linking by NPM Workspaces.

mayan init

This will clone the repositories defined in .mayanrc.js into the directories defined in the path properties.

Implementing a feature is symmetric to git commands. A workflow example:

1. mayan reset makes sure we have the latest changes and are on the base branch
2. mayan checkout -b new-branch-name creates a new branch in all repositories
3. Implement the required changes
4. Commit the changes: mayan add . and mayan commit -m "Implement feature"
5. Push the changes of the affected repositories: mayan push

mayan does not yet support a way to automatically publish all affected packages.

It is currently expected that you version and publish the packages manually with npm version and npm publish in the affected repositories.

Once the packages are upgraded with npm version major/minor/patch and published with npm publish, use:

mayan upgrade @org-name/package-name

This will update the version in all repositories that use the package to the version that is currently on your local machine.

Use:

mayan check

To check that all your repositories use the compatible package version. If not, they will show up either yellow or red with the required version numbers defined.

You can then use

1. mayan add .
2. mayan commit -m "Upgrade package"
3. mayan push

To push the changes to all services.

It is expected that you use your own deployment flow to deploy the services. mayan does not restrict you to using a specific deployment flow and will not do so in the future.

In no particular order

• Support for -a in mayan commit -am "Commit message". When -a is detected, git commit will run in repositories that have unstaged changes, too.
• Show unpushed commits in mayan status
• mayan prune or similar to clean up unused branches and old merged branches.
• mayan pull should not fail when remote is not tracked or when remote is already merged/deleted
• mayan push should not push branch which has been deleted in remote
• Migrate code to TypeScript for better code scaling
• mayan reset should show the changes that are going to be discarded and ask the user for confirmation before continuing
• mayan snap should create a snapshot of the current state of the workspace. This includes the branch state, stashed and unstanshed changes