diff --git a/action.yml b/action.yml index 684e726..ad7f6de 100644 --- a/action.yml +++ b/action.yml @@ -18,19 +18,19 @@ outputs: value: ${{ steps.default.outputs.default_branch }} current_branch: value: ${{ steps.current_branch.outputs.current_branch }} - description: 'Returns the value of the current branch which is consistent regardless of event_type: i.e (push, pull_requests).' + description: 'Returns the value of the current branch which is consistent regardless of event_type e.g main, feature/test, v0.0.1.' base_ref_branch: value: ${{ steps.branch.outputs.base_ref_branch }} - description: 'The target branch of a pull request' + description: 'The target branch of a pull request e.g main' head_ref_branch: value: ${{ steps.branch.outputs.head_ref_branch }} - description: 'The source branch of a pull request' + description: 'The source branch of a pull request e.g feature/test' ref_branch: value: ${{ steps.branch.outputs.ref_branch }} - description: 'The branch that triggered the workflow run.' + description: 'The branch that triggered the workflow run. e.g 1/merge, main' tag: value: ${{ steps.tag.outputs.tag }} - description: 'The tag that triggered the workflow run.' + description: 'The tag that triggered the workflow run. e.g v0.0.1, 0.0.1' runs: using: "composite"