How to configure push rules
For the Eclipse ESCET project, we would like to establish some 'Push Rules'. See https://docs.gitlab.com/ee/push_rules/push_rules.html.
E.g. we want all commit messages to start with the issue number (e.g. '#1 (closed) Some commit'). Using a push rule we can enforce this, in case we forget. I think we'll have use for other push rules as well, e.g. for branch names.
How can we configure this? We don't seem to have any access to project settings.
Activity
mentioned in issue #17 (closed)
For now, we have one push rule request:
- Reason: Ensure commit messages start with the issue number for traceability.
- Rule type: 'Restrict by commit message' (the positive match variant)
- Regular expression:
^#\d+ (.|\n)+$
I don't know what the configuration page looks like, so I hope this is enough information.
I'm not 100% sure about the regular expression, as I can't test it in GitLab.
-
It seems to work. Thanks.
If I violate the rule, it is indeed rejected. However, the message is not very informative. It does not indicate which rule is violated or anything else that is helpful:
Repository https://gitlab.eclipse.org/eclipse/escet/escet.git pre-receive hook declinedIs that something that can be improved?
@fgurr webmaster has an account on gitlab.com. Is there anything I can do to get that issue underway?
assigned to @fgurr
I have created a feature request in the official GitLab issue tracker here: https://gitlab.com/gitlab-org/gitlab/-/issues/287684
-
Previously, as part of this issue, you added for us the following regex for commit messages as push rule:
^#\d+ (.|\n)+$. This ensures that all commit messages must start with an issue number (syntactically at least). This is also a best practice as per the Eclipse Foundation Project Handbook (https://www.eclipse.org/projects/handbook/#resources-commit). The push rule is very useful as we otherwise may forgot to include it in the commit message.We now noticed that this is very impractical for merge commits. When merging using the GitLab web UI, by default the message does not start with an issue number. You can however change the message and add it.
In other situations, e.g. when using Git to merge e.g. 'develop' into a branch for an issue, one also gets merge commits. These are created by Git (e.g. command line Git or EGit). EGit does not allow to change the message (option to modify the commit is missing in right-click menu of such commits). You can change the message via the amend feature, if it is the previous/last commit. But that is not very practical, and definitely not obvious to everyone.
Furthermore, for merge commits, as there are 2 parent commits, what should be the issue number? It may not be so clear.
A practical solution would be to also allow commit messages that start with
Merge.Could you please change the push rule commit message regex for the Eclipse ESCET project to
^(#\d+|Merge) (.|\n)+$.We've been discussing this in the Eclipse ESCET project, see eclipse/escet/escet#10 (closed).
What do you think about all of this? Is it the right solution to allow
Mergeprefixes as well? Should other projects also have such a push rule? -
I think allowing "Merge" as a prefix is a reasonable solution. An alternative could be to avoid merge commits altogether and only allow fast-forward merging.
I have adapted the regex as requested.
Edited by Frederic Gurr -
Is there anything left to do here?
Apart from https://gitlab.com/gitlab-org/gitlab/-/issues/287684, nothing that I'm aware of.
Project Leads have the role of maintainers. Maintainers are allowed to modify the push rules if I am not mistaken.
@ddennis I see that you have the Maintainer role for
https://gitlab.eclipse.org/eclipse/escet/. Please let me know if you are unable to edit the push rules for this project.I think we are done here! Please re-open if you think there is still work to do.
mentioned in issue #1077 (closed)
