Skip to content
This repository has been archived by the owner on Nov 5, 2020. It is now read-only.

Latest commit

 

History

History
109 lines (69 loc) · 5.18 KB

Readme.md

File metadata and controls

109 lines (69 loc) · 5.18 KB
Raw

turnup

npm Build Status

Manage NPM dependencies across repositories, users, projects, teams, and orgs.

Installation

It's recommended to install turnup globally as it stores runtime configuration in your home directory.

> yarn global add turnup
...or
> npm install -g turnup

Introduction

For teams and individuals that rely heavily on NPM modules, it gets cumbersome to move changes upstream. When you update one package, a lot of menial work is done to update packages that depend on it, branch and commit, and finally review those changes. Although a monorepo structure avoids this difficulty entirely, not all scenarios allow for it (especially in orgs where teams have loosely-defined functional dependencies on each other -- see Conway's Law)

Example Use Case

Let's say you host your team's source code in a GitHub org, and you have 25 repositories that all rely on various versions of Jest. You can ask turnup to update Jest across every repo using:

> turnup update jest@latest --owner <teamname>

The update command asks which repositories to update and generates new lock files, creates branches, commits the changes, and initiates pull requests. After this process, a common practice would be for your CI to take over and ensure that tests and builds succeed (and potentially deploy!)

Adapters

Adapters are the method by which turnup interacts with SCM hosts. Turnup supports GitHub, GitLab, Bitbucket Cloud, and Bitbucket Server.

Guide

Configure an Adapter

After installing turnup, you will first need to add authentication for the adapter you would like to use. You may also specify a default adapter for all commands.

For example, you can add a personal access token for GitHub by runnning:

> turnup adapter configure github

To see a list of available adapters, see the help for the configure command. Now you may add GitHub as your default adapter.

> turnup adapter default github

Upating a Module

As shown in the introduction, turnup's main command is update, which will automate updating an NPM dependency across many repositories.

The update command accepts a single argument with many options. The first argument can be:

  1. A name and version number, as in what you would type into npm install. Ex: turnup update [email protected]
  2. A path to a local directory containing a package.json. Ex: turnup update . (useful if you have just published a new version of the package in the current directory)

A required option is any option that specifies target repositories.

option short description
--repos -r Array of full repository names (owner/name)
--owner -o Single owner to find repositories

Updating All Modules

The update-all command runs update against all modules in the repository's package.json (by running npm update). It accepts the same arguments as the update command.

For example:

> turnup update-all --owner <owner>

Lockfiles

Generating lockfiles (package-lock.json, yarn.lock) is the default functionality of the update command but can be turned off through the --no-lockfile option. Lockfiles are also only generated if it already exists in the repository. You can force generating and committing a lockfile by passing the --force-lockfile option with a value of npm or yarn.

Yarn

Turnup is aware of yarn.lock and will use yarn rather than npm to create the lockfile if it exists in the repository.

Contributing

We welcome all contributors. Before making changes, be sure to review the Issues. If you found a bug or are interested in a new feature, please create an issue to get some discussion going.

Maintainers

Aaron Godin - aarongodin

Todo for base functionality

  • --force-lockfile option
  • Allow configuring the remote URL base for an adapter
  • Allow specifying an npm registry to reference other than the public (required for npm tags such as jest@latest)
  • Handle API rate limits
  • Test coverage
  • Give additional feedback on major version jumps, or allow an option to dictate whether major jumps are allowed
  • inspect command to list cumulative (or specific package) dependencies across a set of repos (would be useful for understanding how many versions of a library you depend on and where)
  • Report to JSON so that output is machine readable
  • Use nodegit to look at files. Would reduce API usage if it gets a little too crazy. This might not be possible with private repos.
  • Allow specifying version ranges
  • GH Pages, domain name
  • --skip-repos option for omitting certain repos. For example, you run --owner against an org but don't want to update a subset of those repos. (You can do this through thr prompts but with --continue present, we should support anything the prompts support through flags.