action-conditional-pr-comment

Description

GitHub Action that supports instructing the author of a Pull Request (PR) how to resolve a given problem within the context of a PR. Conditionally adds a comment to the PR with resolution instructions, and once the condition is found to be resolved, allows the previously added comment, if one exists at that time, to be removed from the PR.

Description

GitHub Action that publishes a new release.

Usage

jobs:
    build:
        steps:
            - name: Update dependencies
              uses: open-turo/action-renovate@v1
              with:
                  github-token: ${{ secrets.GITHUB_TOKEN }}

Inputs

name	description	required	default
workflow	ADD indicates the comment is to be added/updated to/within the PR, REMOVE indicates the comment is to be removed from the PR.	true	""
text-detector	This is some unique verbatim subset of the comment that is to be used to determine if a comment has already been created against the PR that instructs the author how to resolve the given problem.	true	created by action-conditional-pr-comment
github-token	GitHub token that can add/update/delete comments. e.g. 'secrets.GITHUB_TOKEN'	true	""
comment	This is the full text of the message to be placed within a comment of the given PR to instruct the author of the PR how to resolve a given problem. This value should be provided for all ADD workflows.	false	fixme
comment-author	The author of the comment upon addition.	false	open-turo-bot

Inputs

parameter	description	required	default
checkout-repo	Perform checkout as first step of action	false	true
checkout-fetch-depth	The number of commits to fetch. 0 indicates all history for all branches and tags	false	0
github-token	GitHub token that can checkout the repository as well as create tags/releases against it. e.g. 'secrets.GITHUB_TOKEN'	true	${{ github.token }}
docker-config-file	Path to the docker config file (defaults to .docker-config.json) Must contain imageName, may contain dockerfile.	false	.docker-config.json
docker-flavor	Docker flavor to use for docker metadata	false	latest=false
dockerhub-user	username for dockerhub	false
dockerhub-password	password for dockerhub	false
npm-auth-token	The Node Package Manager (npm) authentication token. This token is used to authenticate against a private NPM registry configured via a .npmrc file.	false
npm-token	The Node Package Manager (npm) authentication token. This token is used to authenticate against the NPM registry.	false
dry-run	Whether to run semantic release in dry-run mode. It will override the dryRun attribute in your configuration file	false	false
extra-plugins	Extra plugins for pre-install. You can also specify specifying version range for the extra plugins if you prefer. Defaults to install @open-turo/semantic-release-config.	false	@open-turo/semantic-release-config

Outputs

parameter	description
new-release-published	Whether a new release was published
new-release-version	Version of the new release
new-release-major-version	Major version of the new release

Runs

This action is a composite action.

Runs

This action is a composite action.

Development

Install pre-commit and the commit hooks:

pre-commit install
pre-commit install --hook-type commit-msg

Get Help

Please review Issues, post new Issues against this repository as needed.

Contributions

Please see here for guidelines on how to contribute to this project.