Skip to content

Commit a03d9b3

Browse files
committed
update docs
1 parent 7249355 commit a03d9b3

2 files changed

Lines changed: 9 additions & 3 deletions

File tree

.github/workflows/labels.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020
with:
2121
ws-dir: 'test-data'
2222
- name: Bit Pull Request
23-
uses: bit-tasks/pull-request@update-test-data-4
23+
uses: bit-tasks/pull-request@main
2424
with:
2525
version-labels: true
2626
clear-labels: true

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Verify Components in a Pull Request for CI/CD Pipelines
2+
23
Verify the pull request along with the modifications for the Bit components.
34

45
# GitHub Actions
@@ -24,6 +25,7 @@ By default, the label is automatically created in the format `component-name@<ve
2425
When modifying or creating labels manually, supported version keywords for component-specific labels are: `major`, `minor`, and `patch`.
2526

2627
#### Example:
28+
2729
- By default, the `patch` label is automatically added as: `ui/button@patch`.
2830
- It can be modified manually to force a minor version bump: `ui/button@minor`.
2931

@@ -55,6 +57,10 @@ For example:
5557
version-labels-color-major: 'C2E0C6'
5658
```
5759

60+
### `clear-labels`
61+
62+
**Optional** When set to `true`, this task automatically removes all Bit labels from the repository. The default value is `false`.
63+
5864
## Example usage
5965

6066
**Note:** Use `bit-task/init@v1` as a prior step in your action before running `bit-tasks/pull-request@v2`.
@@ -82,11 +88,11 @@ jobs:
8288
- name: Initialize Bit
8389
uses: bit-tasks/init@v1
8490
with:
85-
ws-dir: '<WORKSPACE_DIR_PATH>'
91+
ws-dir: "<WORKSPACE_DIR_PATH>"
8692
- name: Bit Pull Request
8793
uses: bit-tasks/pull-request@v2
8894
with:
89-
version-labels: true # Optional: Add version labels to PR
95+
version-labels: true # Optional: Add version labels to PR
9096
```
9197
9298
# Contributor Guide

0 commit comments

Comments
 (0)