https://github.com/christiangalsterer/stash-filehooks-plugin
An Atlassian Stash plugin to check on various file attributes, like size, name
https://github.com/christiangalsterer/stash-filehooks-plugin
atlassian atlassian-bitbucket bitbucket bitbucket-server
Last synced: about 2 months ago
JSON representation
An Atlassian Stash plugin to check on various file attributes, like size, name
- Host: GitHub
- URL: https://github.com/christiangalsterer/stash-filehooks-plugin
- Owner: christiangalsterer
- License: apache-2.0
- Created: 2015-01-13T17:49:42.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2022-07-28T08:00:10.000Z (almost 3 years ago)
- Last Synced: 2025-03-18T05:12:43.320Z (about 2 months ago)
- Topics: atlassian, atlassian-bitbucket, bitbucket, bitbucket-server
- Language: Java
- Homepage:
- Size: 465 KB
- Stars: 14
- Watchers: 10
- Forks: 27
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Introduction
An Atlassian Bitbucket Server plugin to check on various file attributes, like size, name.
# Installation
The plugin is available in the [Atlassian Marketplace](https://marketplace.atlassian.com/plugins/org.christiangalsterer.stash-filehooks-plugin) and can be installed directly in Bitbucket Server using the Universal Plugin Manager (UPM), see [here](https://marketplace.atlassian.com/plugins/org.christiangalsterer.stash-filehooks-plugin#tabs-installation) for details.
# Configuration
## File Size Hook
In order to configure the hook on a **project** level go to your project and select **Settings** > **Hooks** -> **File Size Hook**.
In order to configure the hook on a **repository** level go to your repository and select **Settings** > **Hooks** > **File Size Hook**.
The following example rejects all files larger then 1MB (1048576 bytes).
## File Name Hook
In order to configure the hook on a **project** level go to your project and select **Settings** > **Merge checks** > **File Name Hook**.
In order to configure the hook on a **repostory** level go to your repository and select **Settings** > **Merge checks** > **File Name Hook**.
The following example rejects all files matching the pattern **readme.md** when the file is pushed or part of a merge request(pull request).
# Releases
3.3.2 (2018-04-15)
* [Fix: FileSize Hook: NullPointerException when size is null](https://github.com/christiangalsterer/stash-filehooks-plugin/issues/43), thanks [lucamilanesio](https://github.com/lucamilanesio) for providing a fix.
3.3.1 (2018-03-03)
* [Fix: Push fails if chnageset is emoty in case commits don't violate File Name Hook or File Size Hook settings](https://github.com/christiangalsterer/stash-filehooks-plugin/issues/41)
3.3.0 (2018-02-28)
* [Performance Improvement: New branch creation causes the plugin to iterate over all changesets](https://github.com/christiangalsterer/stash-filehooks-plugin/issues/1), thanks [raspy](https://github.com/raspy) for providing a fix.
3.2.0 (2017-12-30)
* Compatibility with Bitbucket Server 5.2.x
* [Rework of configuration UI](https://github.com/christiangalsterer/stash-filehooks-plugin/issues/36)
* [Update of documentation for File Name Hook configuration location](https://github.com/christiangalsterer/stash-filehooks-plugin/issues/32)
3.1.0 (2017-11-26)
* [Fix: When multiple size rules use the same size, only last rule is effective](https://github.com/christiangalsterer/stash-filehooks-plugin/issues/31)
* [Feature: File hook should be available at Project level](https://github.com/christiangalsterer/stash-filehooks-plugin/issues/35). Please note that the UI is not perfect yet and will be adjusred in one of the next versions.
3.0.1 (2017-11-12)
* [Fixes in a corner case issue to find the correct git hash](https://github.com/christiangalsterer/stash-filehooks-plugin/issues/27), thanks [syee514](https://github.com/syee514) for providing a fix.
3.0.0 (2017-05-07)
* Compatibility with Bitbucket Server 5.0.x
2.4.0 (2016-09-09)
* File Name Hook:
* Checks the file name pattern also for merge requests(pull requests) and not only for pushes, thanks [ellaz](https://github.com/ellaz) for providing the pull request.
2.3.1 (2016-08-31)
* Fixes an issue with rollback commits and forced pushed to Bitbucket, thanks [ar613](https://github.com/ar613) for providing a fix.
2.3.0 (2016-03-15)
* Allows to specify branch name patterns for the File Size Hook and File Name Hook.
2.2.0 (2016-01-23)
* Tag commits are now excluded
2.1.2 (2016-01-22)
* File Size Hook:
* Fixes: [Deleted files were not excluded from check](https://github.com/christiangalsterer/stash-filehooks-plugin/issues/11)
* File Name Hook:
* Fixes: [Deleted files were not excluded from check](https://github.com/christiangalsterer/stash-filehooks-plugin/issues/11)
2.1.1 (2015-10-18)
* Allows to specify exclude patterns for the File Size Hook and File Name Hook.
2.1.0 (2015-10-18)
* Allows to specify exclude patterns for the File Size Hook and File Name Hook.
2.0.0 (2015-09-29)
* Compatibility with Bitbucket Server 4.0.x
1.1.0 (2015-03-15)
* File Size Hook:
* Allows now to specify up to 5 different pattern and size combinations.
* Fixes: [Plugin crashes when pushing a branch delete #2](https://github.com/christiangalsterer/stash-filehooks-plugin/issues/2)
* File Name Hook:
* New hook which allows to check on the file name and reject pushes if files matches the specified pattern
1.0.0 (2015-01-15)
* Reject commits containing files which exceed a configurable file size. Files can be identified by regular expressions.
# Roadmap
# License
```
Copyright 2015 Christian Galsterer
Copyright 2017 Motorola Solutions, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```