Charles Lyding eb8f1faa4c build: adjust create project script to ensure all built packages are used
The admin create script previously only updated the package.json dependencies
for direct dependencies. This did not ensure that all built packages were used
due to some built packages being used as transitive dependencies. The npm
`overrides` field is now also used to ensure that these dependencies are also
properly redirected to the built packages.
2024-04-18 19:36:10 +02:00
..
2024-03-14 15:46:54 +01:00
2021-07-30 13:43:04 +01:00

DevKit Administrative Scripts

This folder contains all the scripts that can be run using devkit-admin.

In order to be able to use the DevKit scripts, you must first run:

$ npm link

This will link the binaries included in this repository, which includes the devkit-admin binary. This document describes each scripts available.

build

Builds the repo and the pack files. The output of build is in dist/ and contains 1 tgz per package which can be installed (the result of npm pack on that package), and a directory using the name of the package to publish.

Flags:

  • --local. Enable building packages with dependencies to their pack files (instead of versions).
  • --snapshot. Enable building packages with dependencies to their snapshot repos (instead of versions).

packages

Outputs a JSON containing all informations from the package script (main files, repo names, versions, deps, etc).

snapshots

Create and upload snapshots. This is used in CI.

Flags:

  • --force. Force push the snapshot to github.
  • --githubToken=<string>. The github token to update the changelog with. Either this of --githubTokenFile is required.
  • --githubTokenFile=<path>. Reads the githubToken from a file instead of the command line (for CI).

templates

Compile and outputs the templates. For now, only README is being built and outputted.

validate

Performs BUILD files and license validation.

Flags:

  • --verbose. Ignore errors and continue showing outputs.