diff --git a/README.md b/README.md index 23c5b0e..ed74af6 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,48 @@ -# Redmine Drone Plugin +--- +lang: EN_US +--- + +# drone-redmine ## 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 -- Dominik Meyer - - -## Licsense - -Mozilla Public License Version 2.0 +* **Dominik Meyer** - *Initial work* +## License +This project is licensed under the MPLv2 License - see the [LICENSE](LICENSE) file for details.