From 860ebbb307895c229e4c0d866fbdeecea0849a87 Mon Sep 17 00:00:00 2001 From: Luis Beu Date: Thu, 5 Oct 2023 15:34:35 +0200 Subject: [PATCH] Update readme --- README.md | 32 ++++++++++++++++++++++++-------- 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index c90f695..2a8bad7 100644 --- a/README.md +++ b/README.md @@ -39,10 +39,11 @@ Publish a NPM package to the NPM registry. #### Inputs -| Name | Description | Type | Default | Required | -| -------------- | --------------------------- | -------- | -------- | -------- | -| `dist_tag` | NPM dist tag to publish to. | `string` | `latest` | `false` | -| `node_version` | Node version to build on. | `string` | `18` | `false` | +| Name | Description | Type | Default | Required | +| ----------------- | --------------------------- | -------- | -------- | -------- | +| `dist_tag` | NPM dist tag to publish to. | `string` | `latest` | `false` | +| `node_version` | Node version to build on. | `string` | `18` | `false` | +| `package_manager` | Package manager to use. | `choice` | `npm` | `false` | #### Secrets @@ -60,10 +61,11 @@ Publish a NPM package to the GitHub registry. #### Inputs -| Name | Description | Type | Default | Required | -| -------------- | --------------------------- | -------- | ------- | -------- | -| `dist_tag` | NPM dist tag to publish to. | `string` | `` | `true` | -| `node_version` | Node version to build on. | `string` | `18` | `false` | +| Name | Description | Type | Default | Required | +| ----------------- | --------------------------- | -------- | ------- | -------- | +| `dist_tag` | NPM dist tag to publish to. | `string` | `` | `true` | +| `node_version` | Node version to build on. | `string` | `18` | `false` | +| `package_manager` | Package manager to use. | `choice` | `npm` | `false` | #### Secrets @@ -119,6 +121,7 @@ Testing for node app, libraries and components. | Name | Description | Type | Default | Required | | ---------------------- | ------------------------------------------------------------------- | --------- | -------------------------- | -------- | | `node_versions` | Node versions matrix to test on. | `string` | `['16.x', '17.x', '18.x']` | `false` | +| `package_manager` | Package manager to use. | `choice` | `npm` | `false` | | `format_command` | Format command to run. To disable set to `''`. | `string` | `npm run format` | `false` | | `lint_command` | Lint command to run. To disable set to `''`. | `string` | `npm run lint` | `false` | | `build_command` | Build command to run. | `string` | `npm run build` | `false` | @@ -133,6 +136,19 @@ Testing for node app, libraries and components. | `pull-requests` | `write` | Only needed if job is used in a job with the `pull_request` trigger. | | `contents` | `write` | Only needed if job is used in a job with the `push` trigger. | +### [Environment Setup](.github/workflows/environment-setup.yml) + +Checks out the commit, set up the node env and setup the package manager with caching. + +#### Inputs + +| Name | Description | Type | Default | Required | +| ------------------- | -------------------------------- | -------- | ---------------------------- | -------- | +| `node_versions` | Node versions matrix to test on. | `string` | `['16.x', '17.x', '18.x']` | `false` | +| `package_manager` | Package manager to use. | `choice` | `npm` | `false` | +| `dependencies_type` | Dependencies type to install. | `choice` | `prod` | `false` | +| `registry_url` | Registry url to use. | `string` | `https://registry.npmjs.org` | `false` | + ## Directory structure and file naming > Reusable workflows are YAML-formatted files, very similar to any other workflow file. As with other workflow files, you locate reusable workflows in the `.github/workflows` directory of a repository. Subdirectories of the `workflows` directory are not supported.