Skip to content

Commit ec5a754

Browse files
authored
Update README.md
1 parent 5f8538b commit ec5a754

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
# Merge-Monitor
22

3-
A github action bot that checks in pull request if files has been changed based of the lockedFiles.txt. If there has been changesthen it will automatically reject the pull request
3+
A GitHub Action that blocks PRs if they modify any files listed in lockedFiles.txt.
4+
5+
# How to use:
6+
7+
When you add the github action to your repo, on the lockedFiles.txt add the name of the files that you don't want outsiders to change
8+
9+
If you want to allow a pull request to go through even if it modifies locked files, you can add a special label: BYPASS_LABEL
10+
By adding the label you skip the check
411

512
# Demos:
613

@@ -14,9 +21,3 @@ You can also use label only if you want to make changes to files that isn't allo
1421

1522
### Using label
1623
![withLabel](https://github.com/user-attachments/assets/562f8ff4-a6e5-4d3e-8cae-a7e0dde2d5df)
17-
18-
19-
# How to add it to your repositories
20-
21-
- ### First you will need to create a label named BYPASS_LABEL so you can use the feature with label
22-
- ### Then just press the github action download

0 commit comments

Comments
 (0)