Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 1.29 KB

README.md

File metadata and controls

46 lines (30 loc) · 1.29 KB
Raw

rush-archive-project-plugin

A rush plugin for archive/unarchive project source code in monorepo.

Prerequisite

Rush.js >= 5.57.0

Quick Start

  1. Enabling this rush plugin

Please follow the official doc to enable this plugin in your repo.

  1. Running archive project command
rush archive-project --package-name <your_package_name>

restoring your code by rush unarchive-project --package-name <your_package_name>

Archive working process

  1. Find project configuration by Rush.js SDK
  2. Check whether there are projects depends on target project
  3. Run git clean -xdf under project folder
  4. Record project configuration into rush-metadata.json file
  5. Create a tarball by running tar -czf <unscoped_package_name>.tar.gz -C <project_folder> .
  6. Move the tarball to common/_graveyard folder
  7. Remove project config to rush.json
  8. Delete project folder

Unarchive working process

  1. Find the tarball by packageName
  2. Extract the tarball by running tar xf <package_name>.tar.gz
  3. Get project configuration by reading rush-metadata.json
  4. Move the code to project folder
  5. Restore project configuration into rush.json
  6. Delete metadata file and tarball

LICENSE

MIT @chengcyber