actions/branch-names
1
0
Fork 0
mirror of https://github.com/tj-actions/branch-names.git synced 2024-12-27 14:27:59 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Tonye Jack 2023-12-02 04:45:28 -07:00 committed by GitHub
parent 00f78f37b0
commit 564ba51f1b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 38 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
README.md
View File

@ -47,31 +47,31 @@ Get a branch or tag name without the `/ref/*` prefix.
... ...
steps: steps:
- name: Get branch name - name: Get branch names.
id: branch-name id: branch-names
uses: tj-actions/branch-names@v7 uses: tj-actions/branch-names@v7
- name: Running on the default branch. - name: Running on the default branch.
if: steps.branch-name.outputs.is_default == 'true' if: steps.branch-names.outputs.is_default == 'true'
run: | run: |
echo "Running on default: ${{ steps.branch-name.outputs.current_branch }}" echo "Running on default: ${{ steps.branch-names.outputs.current_branch }}"
# Outputs: "Running on default: main" # Outputs: "Running on default: main"
- name: Running on a pull request branch. - name: Running on a pull request branch.
if: steps.branch-name.outputs.is_default == 'false' if: steps.branch-names.outputs.is_default == 'false'
run: | run: |
echo "Running on pr: ${{ steps.branch-name.outputs.current_branch }}" echo "Running on pr: ${{ steps.branch-names.outputs.current_branch }}"
# Outputs: "Running on pr: feature/test" # Outputs: "Running on pr: feature/test"
- name: Running on a pull request branch. - name: Running on a pull request branch.
if: steps.branch-name.outputs.is_default == 'false' if: steps.branch-names.outputs.is_default == 'false'
run: | run: |
echo "Base branch: ${{ steps.branch-name.outputs.base_ref_branch }}" echo "Base branch: ${{ steps.branch-names.outputs.base_ref_branch }}"
# Outputs: "Base branch: main" # Outputs: "Base branch: main"
- name: Running on any event - name: Running on any event.
run: | run: |
echo "Default branch: ${{ steps.branch-name.outputs.default_branch }}" echo "Default branch: ${{ steps.branch-names.outputs.default_branch }}"
# Outputs: "Default branch: main" # Outputs: "Default branch: main"
``` ```
@ -133,34 +133,34 @@ on:
... ...
steps: steps:
- name: Get branch names - name: Get branch names
id: branch-name id: branch-names
uses: tj-actions/branch-names@v7 uses: tj-actions/branch-names@v7
- name: Current branch name - name: Current branch names
run: | run: |
echo "${{ steps.branch-name.outputs.current_branch }}" echo "${{ steps.branch-names.outputs.current_branch }}"
# Outputs: "main" the branch that triggered the push event. # Outputs: "main" the branch that triggered the push event.
- name: Running on the default branch. - name: Running on the default branch.
if: steps.branch-name.outputs.is_default == 'true' if: steps.branch-names.outputs.is_default == 'true'
run: | run: |
echo "Running on default: ${{ steps.branch-name.outputs.current_branch }}" echo "Running on default: ${{ steps.branch-names.outputs.current_branch }}"
# Outputs: "Running on default: main". # Outputs: "Running on default: main".
- name: Running on the default branch (i.e non tag based branch). - name: Running on the default branch (i.e non tag based branch).
if: steps.branch-name.outputs.is_tag == 'false' && steps.branch-name.outputs.is_default == 'true' if: steps.branch-names.outputs.is_tag == 'false' && steps.branch-names.outputs.is_default == 'true'
run: | run: |
echo "Running on branch: ${{ steps.branch-name.outputs.current_branch }}" echo "Running on branch: ${{ steps.branch-names.outputs.current_branch }}"
# Outputs: "Running on branch: main". # Outputs: "Running on branch: main".
- name: Get Ref brach name - name: Get Ref brach name
run: | run: |
echo "${{ steps.branch-name.outputs.ref_branch }}" echo "${{ steps.branch-names.outputs.ref_branch }}"
# Outputs: "main" # Outputs: "main"
- name: Default branch name - name: Default branch name
run: | run: |
echo "${{ steps.branch-name.outputs.default_branch }}" echo "${{ steps.branch-names.outputs.default_branch }}"
# Outputs: "main" the default branch. # Outputs: "main" the default branch.
``` ```
@ -175,44 +175,44 @@ on:
... ...
steps: steps:
- name: Get branch names - name: Get branch names
id: branch-name id: branch-names
uses: tj-actions/branch-names@v7 uses: tj-actions/branch-names@v7
- name: Current branch name - name: Current branch names
run: | run: |
echo "${{ steps.branch-name.outputs.current_branch }}" echo "${{ steps.branch-names.outputs.current_branch }}"
# Outputs: "feature/test" current PR branch. # Outputs: "feature/test" current PR branch.
- name: Running on a non tag based branch and a PR branch. - name: Running on a non tag based branch and a PR branch.
if: steps.branch-name.outputs.is_default == 'false' if: steps.branch-names.outputs.is_default == 'false'
run: | run: |
echo "Running on branch: ${{ steps.branch-name.outputs.current_branch }}" echo "Running on branch: ${{ steps.branch-names.outputs.current_branch }}"
# Outputs: "Running on branch: feature/test". # Outputs: "Running on branch: feature/test".
- name: Running on a pull request (i.e non tag based branch). - name: Running on a pull request (i.e non tag based branch).
if: steps.branch-name.outputs.is_tag == 'false' && steps.branch-name.outputs.is_default == 'false' if: steps.branch-names.outputs.is_tag == 'false' && steps.branch-names.outputs.is_default == 'false'
run: | run: |
echo "Running on branch: ${{ steps.branch-name.outputs.current_branch }}" echo "Running on branch: ${{ steps.branch-names.outputs.current_branch }}"
# Outputs: "Running on branch: feature/test". # Outputs: "Running on branch: feature/test".
- name: Get Ref branch name - name: Get Ref branch name
run: | run: |
echo "${{ steps.branch-name.outputs.ref_branch }}" echo "${{ steps.branch-names.outputs.ref_branch }}"
# Outputs: "1/merge" # Outputs: "1/merge"
- name: Get Head Ref branch name (i.e The current pull request branch) - name: Get Head Ref branch names (i.e The current pull request branch)
run: | run: |
echo "${{ steps.branch-name.outputs.head_ref_branch }}" echo "${{ steps.branch-names.outputs.head_ref_branch }}"
# Outputs: "feature/test" current PR branch. # Outputs: "feature/test" current PR branch.
- name: Get Base Ref branch name (i.e The target of a pull request.) - name: Get Base Ref branch names (i.e The target of a pull request.)
run: | run: |
echo "${{ steps.branch-name.outputs.base_ref_branch }}" echo "${{ steps.branch-names.outputs.base_ref_branch }}"
# Outputs: "main". # Outputs: "main".
- name: Default branch name - name: Default branch names
run: | run: |
echo "${{ steps.branch-name.outputs.default_branch }}" echo "${{ steps.branch-names.outputs.default_branch }}"
# Outputs: "main" the default branch. # Outputs: "main" the default branch.
``` ```
@ -227,21 +227,21 @@ on:
... ...
steps: steps:
- name: Get branch names - name: Get branch names
id: branch-name id: branch-names
uses: tj-actions/branch-names@v7 uses: tj-actions/branch-names@v7
with: with:
strip_tag_prefix: v # Optionally strip the leading `v` from the tag. strip_tag_prefix: v # Optionally strip the leading `v` from the tag.
- name: Running on a tag branch. - name: Running on a tag branch.
if: steps.branch-name.outputs.is_tag == 'true' if: steps.branch-names.outputs.is_tag == 'true'
run: | run: |
echo "Running on: ${{ steps.branch-name.outputs.tag }}" echo "Running on: ${{ steps.branch-names.outputs.tag }}"
# Outputs: "Running on: 0.0.1". # Outputs: "Running on: 0.0.1".
- name: Get the current tag - name: Get the current tag
if: steps.branch-name.outputs.is_tag == 'true' # Replaces: startsWith(github.ref, 'refs/tags/') if: steps.branch-names.outputs.is_tag == 'true' # Replaces: startsWith(github.ref, 'refs/tags/')
run: | run: |
echo "${{ steps.branch-name.outputs.tag }}" echo "${{ steps.branch-names.outputs.tag }}"
# Outputs: "0.0.1" # Outputs: "0.0.1"
``` ```