Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
60471a75
Commit
60471a75
authored
Jun 23, 2017
by
Sean McGivern
Browse files
Options
Browse Files
Download
Plain Diff
Merge branch 'patch-1' into 'master'
fix typos & add links in Push Rules docu [skip ci] See merge request !757
parents
2a5ef580
8cb59853
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
8 additions
and
6 deletions
+8
-6
doc/push_rules/push_rules.md
doc/push_rules/push_rules.md
+8
-6
No files found.
doc/push_rules/push_rules.md
View file @
60471a75
# Push Rules
# Push Rules
Sometimes you need additional control over pushes to your repository.
Sometimes you need additional control over pushes to your repository.
GitLab already offers
protected branches
.
GitLab already offers
[
protected branches
][
protected-branches
]
.
But there are cases when you need some specific rules like preventing git tag removal or enforcing a special format for commit messages.
But there are cases when you need some specific rules like preventing git tag removal or enforcing a special format for commit messages.
GitLab Enterprise Edition offers a user-friendly interface for such cases.
GitLab Enterprise Edition offers a user-friendly interface for such cases.
Push Rules are defined per project so you can have different rules applied to different projects depend
s
on your needs.
Push Rules are defined per project so you can have different rules applied to different projects depend
ing
on your needs.
Push Rules settings can be found at Project settings -> Push Rules page.
Push Rules settings can be found at Project settings -> Push Rules page.
## How to use
## How to use
Let's assume you have the following requirements for your workflow:
Let's assume you have the following requirements for your workflow:
*
every commit should reference a
reference JIRA issue. For example:
`Refactored css. Fixes JIRA-123.
`
*
every commit should reference a
JIRA issue. For example:
`Refactored css. Fixes JIRA-123.
`
*
users should not be able to remove git tags with
`git push`
*
users should not be able to remove git tags with
`git push`
All you need to do is write simple regular expression that requires mention of JIRA issue in a commit message.
All you need to do is write simple regular expression that requires mention of
a
JIRA issue in a commit message.
It can be something like this
`/JIRA\-\d+/`
.
It can be something like this
`/JIRA\-\d+/`
.
Just paste regular expression into
commit message textfield
(without start and ending slash) and save changes.
Just paste regular expression into
the commit message textfield
(without start and ending slash) and save changes.
See the screenshot below:
See the screenshot below:
![
screenshot
](
push_rules.png
)
![
screenshot
](
push_rules.png
)
Now when a user tries to push a commit like
`Bugfix`
- their push will be declined.
Now when a user tries to push a commit like
`Bugfix`
- their push will be declined.
And pushing commit with message
like
`Bugfix according to JIRA-123`
will be accepted.
Only pushing commits with messages
like
`Bugfix according to JIRA-123`
will be accepted.
## Prevent pushing secrets to the repository
## Prevent pushing secrets to the repository
...
@@ -91,3 +91,5 @@ pry.history
...
@@ -91,3 +91,5 @@ pry.history
bash_history
bash_history
```
```
[
protected-branches
]:
https://docs.gitlab.com/ee/user/project/protected_branches.html
"Protected Branches documentation"
\ No newline at end of file
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment