Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update atlassian-plugin.xml to support Bitbucket 7.16 #2

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Update atlassian-plugin.xml to support Bitbucket 7.16 #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2663910
Update bitbucket version to 7.16
severingafner Sep 20, 2021
03c2c4f
Update POM description and added myself as developer
severingafner Sep 20, 2021
c3f3778
Update the tested version in the README
severingafner Sep 20, 2021
518ff6e
Change repository-hook to repository-merge-check for the new Bitbucke…
severingafner Sep 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Bitbucket Merge Checker

You always wanted a way to validate the commit message you enter when you merge a branch on Bitbucket, right? well, now you can!
You always wanted a way to validate the commit message you enter when you merge a branch on Bitbucket, right? well, now you can!
This is a simple (yet uncommon) merge checker for Bitbucket which can be customized and toggled on and off at both the Project and the Repo level.

## Getting started
### Installing
In order to enjoy the plugin you first need to install it on you Bitbucket server, and you have 2 options for that:
In order to enjoy the plugin you first need to install it on you Bitbucket server, and you have 2 options for that:
> You need to have administrator permissions to be able to install plugins on your Bitbucket server
#### Option 1 :: The Marketplace
1. On Bitbucket, go to the [Marketplace](https://marketplace.atlassian.com/addons/app/bitbucket) and search for "Bitbucket merge checker"
Expand All @@ -31,7 +31,7 @@ By default the plugin is disabled for all projects and repos. To activate it for
![The plugin installed on the manage apps page](assets/plugin-on-avilalbe-marge-checks.png)
3. Toggle the "Merge checker hook" on. You will be prompted with the plugin configuration dialog (see image below). Currently the plugin only supports validation over commit messages.
![The plugin installed on the manage apps page](assets/plugin-configuration-dialog.png)
4. Fill the fields (all are required)
4. Fill the fields (all are required)
* Merge commit message Regex - The Regex against the commit message will be validated
* A summary notification - The summary message displayed when the commit was rejected
* A detailed notification - The detailed message displayed when the commit was rejected. Here you might wanna elaborate on the standards the commit message should adhere to.
Expand All @@ -40,25 +40,25 @@ By default the plugin is disabled for all projects and repos. To activate it for
Try your new merge check!

## Contributing
We are looking forward to making this plugin even better and will appreciate any contribution in efforts to make it so.
We are looking forward to making this plugin even better and will appreciate any contribution in efforts to make it so.
### Launching Bitbucket with the plugin
1. Fork the repository to you local machine
2. Download the Atlassian SDK (see more details [here](https://developer.atlassian.com/server/framework/atlassian-sdk/set-up-the-atlassian-plugin-sdk-and-build-a-project/))
3. Navigate to the repository directory on your local machine and run `atlas-run`. This will trigger the mvn goal which builds and launches a local Bitbucket server.
3. Navigate to the repository directory on your local machine and run `atlas-run`. This will trigger the mvn goal which builds and launches a local Bitbucket server.

Now You should be able to navigate to Bitbucket on your local machine and see the plugin installed on it.
### Modifying and checking
Now You should be able to navigate to Bitbucket on your local machine and see the plugin installed on it.
### Modifying and checking
The plugin support a sort of live-reloading OOTB, which means that after each modification you made you can run `atlas-package` on the repository root directory and refresh the Bitbucket page to see your changes.

### Running tests
In order to run the tests you should run the following command from the project's root directory: `atlas-unit-test`.
In order to run the tests you should run the following command from the project's root directory: `atlas-unit-test`.
This will run the unit tests.

### Bitbucket Server version compatibility
This plugin was tested for Bitbucket-Server@5.16.0, but it might still work on lower versions than that.
This plugin was tested for Bitbucket-Server@7.16.0, but it might still work on lower versions than that.

### i18n support
Currently only the English language is supported.

### License
Bitbucket Merge Checker is [Apache License Version 2.0 licensed](./LICENSE).
Bitbucket Merge Checker is [Apache License Version 2.0 licensed](./LICENSE).
12 changes: 10 additions & 2 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<packaging>atlassian-plugin</packaging>

<name>Bitbucket merge checker</name>
<description>This is the com.myheritage.bitbucket:bitbucket-merge-checker plugin for Atlassian Bitbucket Server.</description>
<description>This Plugin allows the admin to set a Regex merge check on projects and repositories. The Regex has to be matched in order to make a commit (PR merge)</description>

<organization>
<name>MyHeritage</name>
Expand Down Expand Up @@ -44,6 +44,14 @@
<role>developer</role>
</roles>
</developer>
<developer>
<name>Severin Gafner</name>
<organization>Bucher + Suter Ag</organization>
<organizationUrl>https://bucher-suter.com</organizationUrl>
<roles>
<role>developer</role>
</roles>
</developer>
</developers>

<contributors>
Expand All @@ -55,7 +63,7 @@
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

<amps.version>8.0.2</amps.version>
<bitbucket.version>5.16.0</bitbucket.version>
<bitbucket.version>7.16.0</bitbucket.version>
<bitbucket.data.version>${bitbucket.version}</bitbucket.data.version>

<!-- This property ensures consistency between the key in atlassian-plugin.xml and the OSGi bundle's key. -->
Expand Down
6 changes: 3 additions & 3 deletions src/main/resources/atlassian-plugin.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

<resource type="i18n" name="i18n" location="bitbucket-merge-checker"/>

<repository-hook name="Merge checker hook" key="isValidCommitMessageMergeCheck" class="bean:isValidCommitMessageMergeCheck">
<repository-merge-check name="Merge checker hook" key="isValidCommitMessageMergeCheck" configurable="true" class="bean:isValidCommitMessageMergeCheck">
<description>Runs checks before a PR is merged</description>
<icon>images/pluginLogo.png</icon>
<scopes>
Expand All @@ -21,5 +21,5 @@
<directory location="/static/"/>
</config-form>
<validator>com.myheritage.bitbucket.merge.checks.IsValidCommitMessageSettingsValidator</validator>
</repository-hook>
</atlassian-plugin>
</repository-merge-check>
</atlassian-plugin>