Skip to content

autoinvent/conveyor

main
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 

conveyor

Frontend libraries for building an AutoInvent application

Packages

Development

Packages are managed using rush

Prerequisites

  1. Node.js

  2. rush

    npm install --global @microsoft/rush

Rush Cheatsheet

Refer to rush documention for complete explantions.

Installing all dependencies (for all projects)

rush install

Installing a new dependency to a single project

cd into/project
rush add --package example-lib
  • Manually updating the package.json and running rush update will also work.
  • Hint: Adding the flag -m or --make-consistent will cause other packages using this dependency to use the same version

Building (all) projects

rush build

Updating after a package.json file has changed

rush update

Documenting changes for the next package release (write changelogs)

rush change

Removing all temporary folders created by Rush

rush purge

Linting

rush lint

Building .tgz files for all packages (outputs to current directory)

rush publish --pack --include-all --publish --release-folder .

Workflow

  1. Pull the latest

    git checkout main && git pull
  2. Create branch for changes

    git checkout -b <branchname>
  3. Make changes

  4. Stage and commit changes with conventional commit message (type(scope): description)

    • note that the scope of the commit is the package name (repo when affecting more than one)
    • see commit log for examples
  5. Document changes for the next release

    rush change
    • This command should be run once you are ready to merge your PR, after all your changes have been committed to the branch. It analyzes the changes in your branch and (when necessary) prompts you to write human-readable descriptions of your changes.
    • See here for best practices when writing the changelogs
  6. Commit and push the changelog files generated by rush

TODO

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages