actions-marketplace-validations/Sync package.json with repo info
GitHub Action that syncs package.json wpository metadata (description, homepage, topics/keywords).
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| githubToken | Repository token for allowing the action to make commits or change the repository info. If direction is "overwrite-file", this input be set from forwarding secrets.GITHUB_TOKEN in the workflow file. If direction is "overwrite-github", a custom personal access token with "repo" scope has to be created. | yes | — |
| approve | If true and direction is "overwrite-file", pull requests created by this action are automatically approved and merged. | no | true |
| removeBranch | If true and direction is "overwrite-file" and approve is also true, automatically merged pull requests will delete their branch afterwards. | no | true |
| commitMessage | Commit message for package.json changes (only for direction "overwrite-file"). Substring “{changes}” will be replaced with a list of changed package.json fields. | no | autofix: Updated package.json[{changes}] |
| syncDescription | If true, package.json[description] will be synced with GitHub repository description. | no | true |
| syncHomepage | If true, package.json[homepage] will be synced with GitHub repository homepage. | no | true |
| syncKeywords | If true, package.json[keywords] will be synced with GitHub repository topics. | no | true |
| direction | The syncing direction, can be "overwrite-file" or "overwrite-github". If "overwrite-file", the file package.json will be edited in a pull request according to the GitHub repository info. If "overwrite-github", the GitHub repository info will be changed according to the content of the package.json file. | no | overwrite-file |
| jsonFinalNewline | If true and direction is "overwrite-file", the updated package.json will have a final newline. | no | true |
| branch | The name of the branch to make changes on (only for direction "overwrite-file"). Substring “{random}” will be replaced with randomized characters. | no | action-sync-node-meta |
Outputs
no outputs