From e2225ad1db4e264094cbe011fee999300c671c92 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Karel=20Pi=C4=8Dman?= Date: Thu, 24 Oct 2024 07:59:04 +0200 Subject: [PATCH] v3.2.5 ddevel started --- .github/workflows/rubyonrails.yml | 4 ++-- CHANGELOG.md | 3 +++ README.md | 35 ++++++++++++------------------- init.rb | 2 +- 4 files changed, 19 insertions(+), 25 deletions(-) diff --git a/.github/workflows/rubyonrails.yml b/.github/workflows/rubyonrails.yml index 58a44aed..e64333c7 100644 --- a/.github/workflows/rubyonrails.yml +++ b/.github/workflows/rubyonrails.yml @@ -21,9 +21,9 @@ name: "GitHub CI" on: push: - branches: ["master"] + branches: ["devel"] pull_request: - branches: ["master"] + branches: ["devel"] jobs: plugin_tests: strategy: diff --git a/CHANGELOG.md b/CHANGELOG.md index 150b86c9..f7e243b9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,9 @@ Changelog for Redmine DMSF ========================== +3.2.5 *???-??-??* +------------------ + 3.2.4 *2024-10-24* ------------------ diff --git a/README.md b/README.md index 1484debb..7713fe86 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ -Redmine DMSF Plugin 3.2.4 -========================= +# Redmine DMSF Plugin 3.2.5 devel -[![GitHub CI](https://github.com/danmunn/redmine_dmsf/actions/workflows/rubyonrails.yml/badge.svg?branch=master)](https://github.com/danmunn/redmine_dmsf/actions/workflows/rubyonrails.yml) +[![GitHub CI](https://github.com/danmunn/redmine_dmsf/actions/workflows/rubyonrails.yml/badge.svg?branch=devel)](https://github.com/danmunn/redmine_dmsf/actions/workflows/rubyonrails.yml) [![Support Ukraine Badge](https://bit.ly/support-ukraine-now)](https://github.com/support-ukraine/support-ukraine) Redmine DMSF is Document Management System Features plugin for Redmine issue tracking system; It is aimed to replace current Redmine's Documents module. @@ -19,8 +18,7 @@ Redmine is a flexible project management web application, released under the ter Further information about the GPL license can be found at -Features --------- +## Features * Directory structure * Document versioning / revision history @@ -42,8 +40,7 @@ Features * DMS Document revision as a custom field type * Compatible with Redmine 5.0.x -Dependencies ------------- +## Dependencies * Redmine 5.0 or higher @@ -134,7 +131,7 @@ sudo yum install xapian-core xapian-bindings-ruby libxapian-dev poppler-utils an libwps-tools gzip unrtf catdvi djview djview3 uuid uuid-dev xz libemail-outlook-message-perl ``` -### Inline displaying of office documents (optional) +## Inline displaying of office documents (optional) If LibreOffice binary `libreoffice` is present in the server, office documents (.odt, .ods,...) are displayed inline. The command must be runable by the web app's user. Test it in advance, e.g: @@ -147,21 +144,18 @@ The command must be runable by the web app's user. Test it in advance, e.g: sudo apt install libreoffice liblibreoffice-java ``` -Usage ------ +## Usage DMSF is designed to act as project module, so it must be checked as an enabled module within the project settings. Search will now automatically search DMSF content when a Redmine search is performed, additionally a "Documents" and "Folders" check box will be visible, allowing you to search DMSF content exclusively. -Linking DMSF object from Wiki entries (macros) ---------------------------------------------- +## Linking DMSF object from Wiki entries (macros) You can link DMSF object from Wikis using a macro tag `{{ }}`. List of available macros with their description is available from the wiki's toolbar. -Hooks ------ +## Hooks You can implement these hooks in your plugin and extend DMSF functionality in certain events. @@ -200,8 +194,7 @@ expected that the file is sent by the hook. parameters: *file* -Setup / Upgrade ---------------- +## Setup / Upgrade You can either clone the master branch or download the latest zipped version. Before installing ensure that the Redmine instance is stopped. @@ -316,8 +309,8 @@ it's necessary to add the following configuration option into your `config/addit config.relative_url_root = '/redmine' ``` -Uninstalling DMSF ------------------ +## Uninstalling DMSF + Before uninstalling the DMSF plugin, please ensure that the Redmine instance is stopped. 1. `cd [redmine-install-dir]` @@ -326,16 +319,14 @@ Before uninstalling the DMSF plugin, please ensure that the Redmine instance is After these steps re-start your instance of Redmine. -Contributing ------------- +## Contributing If you've added something, why not share it. Fork the repository (github.com/danmunn/redmine_dmsf), make the changes and send a pull request to the maintainers. Changes with tests, and full documentation are preferred. -Additional Documentation ------------------------- +## Additional Documentation [CHANGELOG.md](CHANGELOG.md) - Project changelog diff --git a/init.rb b/init.rb index 06e15c2f..cfd31ef2 100644 --- a/init.rb +++ b/init.rb @@ -24,7 +24,7 @@ author_url 'https://github.com/danmunn/redmine_dmsf/graphs/contributors' author 'Vít Jonáš / Daniel Munn / Karel Pičman' description 'Document Management System Features' - version '3.2.4' + version '3.2.5 devel' requires_redmine version_or_higher: '5.0.0'