chore: updated the readme of the project
Some checks failed
continuous-integration/drone/push Build is passing
continuous-integration/drone Build is failing

This commit is contained in:
Dominik Meyer 2024-08-14 10:51:09 +02:00
parent ce5c159037
commit 8086ed9686
Signed by: byterazor
GPG Key ID: EABDA0FD5981BC97

View File

@ -1,22 +1,48 @@
# Redmine Drone Plugin ---
lang: EN_US
---
# drone-redmine
## Description ## Description
Drone plugin for updating tickits and uploading files in Redmine from within Drone CI/CD pipeline. This repository contains a Containerfile for building a drone plugin to interact with the [Redmine](https://redmine.org) API.
### Alert
This is very early work and may and may not work for you yet.
### PLUGIN Variables
* `REDMINE_URL` - the URL to your redmine server (required)
* `REDMINE_TOKEN` - your Redmine API TOKEN (required)
* `PROJECT_ID` - the project id (required) to work on
* `UPLOAD_FILES` - ("true"|"false") - upload files from build (default: "false")
* `FILES` - space separated list of files to upload in the format PATH:REDMINE_FILENAME:DESCRIPTION:VERSION_ID (optional)
## Supported Architectures
- amd64
- arm64
## Updates
I am trying to update the image weekly as long as my private kubernetes cluster is available. So I do not promise anything and do **not** rely
your business on this image.
## Documentation ## Source Repository
T.B.D * https://gitea.federationhq.de/Container/drone-redmine-plugin
## Prebuild Images
* https://hub.docker.com/repository/docker/byterazor/drone-redmine/general
## Authors ## Authors
- Dominik Meyer <dmeyer@federationhq.de> * **Dominik Meyer** - *Initial work*
## Licsense
Mozilla Public License Version 2.0
## License
This project is licensed under the MPLv2 License - see the [LICENSE](LICENSE) file for details.