Skip to content

Commit 64d83e9

Browse files
authored
docs(README): add missing action inputs + package options (#1176)
The README was missing some action inputs and package options. This PR adds those missing inputs and options. (In my case, I was looking for `draft-pull-request`.)
1 parent 16a9c90 commit 64d83e9

1 file changed

Lines changed: 17 additions & 2 deletions

File tree

‎README.md‎

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,10 @@ steps:
8484
| `proxy-server` | Configure a proxy server in the form of `<host>:<port>` e.g. `proxy-host.com:8080` |
8585
| `skip-github-release` | If `true`, do not attempt to create releases. This is useful if splitting release tagging from PR creation. |
8686
| `skip-github-pull-request` | If `true`, do not attempt to create release pull requests. This is useful if splitting release tagging from PR creation. |
87-
| `skip-labeling` | If `true`, do not attempt to label the PR. |
87+
| `skip-labeling` | If `true`, do not attempt to label the PR. |
88+
| `changelog-host` | The proto://host where commits live. Defaults to `${{ github.server_url }}` (usually `https://github.com`) |
89+
| `versioning-strategy` | The versioning strategy to use. Defaults to `default` |
90+
| `release-as` | The version to release as. |
8891

8992
## GitHub Credentials
9093

@@ -411,6 +414,7 @@ you can see a mapping of the old option to the new option:
411414
| `component` | `$.packages[path].component` | Package-only option |
412415
| `package-name` | `$.packages[path].package-name` | Package-only option |
413416
| `always-link-local` | `$.always-link-local` | Root-only option |
417+
| `always-update` | `$.always-update` | Root-only option |
414418
| `bootstrap-sha` | `$.bootstrap-sha` | Root-only option |
415419
| `commit-search-depth` | `$.commit-search-depth` | Root-only option |
416420
| `group-pull-request-title-pattern` | `$.group-pull-request-title-pattern` | Root-only option |
@@ -425,22 +429,33 @@ you can see a mapping of the old option to the new option:
425429
| `changelog-host` | `$.changelog-host` or `$.packages[path].changelog-host` | Root or per-package option |
426430
| `changelog-notes-type` | `$.changelog-type` or `$.packages[path].changelog-type` | Root or per-package option |
427431
| `changelog-types` | `$.changelog-sections` or `$.packages[path].changelog-sections` | Root or per-package option |
432+
| `component-no-space` | `$.component-no-space` or `$.packages[path].component-no-space` | Root or per-package option |
433+
| `date-format` | `$.date-format` or `$.packages[path].date-format` | Root or per-package option |
434+
| `draft` | `$.draft` or `$.packages[path].draft` | Root or per-package option |
435+
| `draft-pull-request` | `$.draft-pull-request` or `$.packages[path].draft-pull-request` | Root or per-package option |
436+
| `exclude-paths` | `$.exclude-paths` or `$.packages[path].exclude-paths` | Root or per-package option |
428437
| `extra-files` | `$.extra-files` or `$.packages[path].extra-files` | Root or per-package option |
438+
| `extra-labels` | `$.extra-labels` or `$.packages[path].extra-labels` | Root or per-package option |
429439
| `include-v-in-tag` | `$.include-v-in-tag` or `$.packages[path].include-v-in-tag` | Root or per-package option |
440+
| `initial-version` | `$.initial-version` or `$.packages[path].initial-version` | Root or per-package option |
430441
| `labels` | `$.label` or `$.packages[path].label` | Root or per-package option |
431442
| `monorepo-tags` | `$.include-component-in-tag` or `$.packages[path].include-component-in-tag` | Root or per-package option |
432443
| `prerelease` | `$.prerelease` or `$.packages[path].prerelease` | Root or per-package option |
444+
| `prerelease-type` | `$.prerelease-type` or `$.packages[path].prerelease-type` | Root or per-package option |
445+
| `pull-request-footer` | `$.pull-request-footer` or `$.packages[path].pull-request-footer` | Root or per-package option |
433446
| `pull-request-header` | `$.pull-request-header` or `$.packages[path].pull-request-header` | Root or per-package option |
434447
| `pull-request-title-pattern` | `$.pull-request-title-pattern` or `$.packages[path].pull-request-title-pattern` | Root or per-package option |
435448
| `release-as` | `$.release-as` or `$.packages[path].release-as` | Root or per-package option |
436449
| `release-labels` | `$.release-label` or `$.packages[path].release-label` | Root or per-package option |
437450
| `release-type` | `$.release-type` or `$.packages[path].release-type` | Root or per-package option |
438451
| `separate-pull-requests` | `$.separate-pull-requests` or `$.packages[path].separate-pull-requests` | Root or per-package option |
452+
| `skip-changelog` | `$.skip-changelog` or `$.packages[path].skip-changelog` | Root or per-package option |
439453
| `skip-github-release` | `$.skip-github-release` or `$.packages[path].skip-github-release` | Root or per-package option |
454+
| `skip-snapshot` | `$.skip-snapshot` or `$.packages[path].skip-snapshot` | Root or per-package option |
440455
| `snapshot-labels` | `$.snapshot-label` or `$.packages[path].snapshot-label` | Root or per-package option |
441456
| `tag-separator` | `$.tag-separator` or `$.packages[path].tag-separator` | Root or per-package option |
442457
| `version-file` | `$.version-file` or `$.packages[path].version-file` | Root or per-package option |
443-
| `versioning-strategy` | `$.versioning` or `$.packages[path].versioning` | Root or per-package option |
458+
| `versioning-strategy` | `$.versioning-strategy` or `$.packages[path].versioning-strategy` | Root or per-package option |
444459

445460
## License
446461

0 commit comments

Comments
 (0)