0.0.0 • Published 4 years ago
jsii-library-template v0.0.0
jsii-library-template
Template for a jsii library project.
Configuration
- Edit
.projenrc.jsand go through all the fields to update for your project. - Add the following GitHub secrets to your project (see jsii-release for instructions):
NPM_TOKENMAVEN_USERNAME,MAVEN_PASSWORD,MAVEN_GPG_PRIVATE_KEY,MAVEN_GPG_PRIVATE_KEY_PASSPHRASE,MAVEN_STAGING_PROFILE_ID,TWINE_USERNAME,TWINE_PASSWORDNUGET_API_KEY
Usage
This is a projen project. This means that all project configuration is derived from .projenrc.js and generated on-demand.
After cloning this repo, run:
npx projenIn order to bootstrap project configuration files, like package.json.
Then, you can use yarn for your workflow:
| Command | Description |
|---|---|
yarn install | Install dependencies |
yarn compile | Compile to JavaScript |
yarn watch | Watch for changes and compile |
yarn test | Run tests |
yarn run package | Create dist with bundles for all languages |
yarn build | Compile + test + package |
yarn bump | Bump a new version (based on conventional commits) |
yarn release | Bump + push |
yarn compat | Run API compatibility check against latest |