mylyn-gitea/README.md

60 lines
3.0 KiB
Markdown

# Mylyn/Gitea Tasks Connector
Gitea Issues management for Eclipse/Mylyn.
This Mylyn connector will allow you to connect Mylyn to a Gitea's instance (self hosted or not) in order to manage your issues from your local Eclipse instance.
* The plug-in is available in the Eclipse Market place
* Direct installation and Update packages are available as an Eclipse Update Site: https://teilginn.github.io/mylyn-gitea-updatesite/
* Official project repositories are maintained in [mylyn-gitea](https://forge.chapril.org/gitea/mylyn-gitea/) and [mylyn-gitea-updatesite](ttps://forge.chapril.org/gitea/mylyn-gitea-updatesit/) repositories and mirrored as Github repositories?
* Feel free to use [Github Issues](https://github.com/teilginn/mylyn-gitea/issues) to Report issues or request new features
Note about Github repositories:
As you may have noticed, I'm not using Github as main source repository but a [Gitea](https://gitea.io) instance provided by the [French April](https://www.april.org) association .
Most of people who may report issues have already a Github account. This is why Github is used as issue management system.
## License
Copyright(c) 2021 F.Terrot
Mylyn/Gitea Tasks Connector is released under the MIT License, see the [LICENSE](https://forge.chapril.org/gitea/mylyn-gitea/src/branch/main/LICENSE) file for full license text.
### Credits
1. Logos and Icons are coming from the [Gitea Theme](https://gitea.com/gitea/theme).
They are released are under the Apache-2.0 License. See the [LICENSE](https://gitea.com/gitea/theme/src/commit/8fc0c6257da900c86cb6c56e0541bb7a807c3349/LICENSE) file for the full license text.
Copyright (c) 2016 The Gitea Authors <https://gitea.io>
### Thanks
I want to thanks and credit:
* pweingardt for the [Mylyn Gilab Connector](https://github.com/pweingardt/mylyn-gitlab), which helps me in my initial plug-ins setup.
* zeripath for the [Java Gitea API](https://github.com/zeripath/java-gitea-api), I used first to communicate with Gitea's instance before facing ssl and JDK 11 compliance issues.
* The French [April](https://www.april.org) association for providing the [forge.chapril.org](https://forge.chapril.org) [Gitea](https://gitea.io) instance thanks to their [Chapril](https://www.chapril.org] project.
## Usage
see (Mylyn/Gitea Tasks Connector plug-ins update site)[https://forge.chapril.org/gitea/mylyn-gitea-updatesite]
## Known issues/Limitations
* [Known issues](https://github.com/teilginn/mylyn-gitea/issues?q=is%3Aopen+is%3Aissue)
* [known limitations](https://github.com/teilginn/mylyn-gitea/labels/known_limitation)
To avoid any account management activity, issues tracker is handled at [Github Issues](https://github.com/teilginn/mylyn-gitea/issues).
Feel free to open issues to report bugs or request new features.
### Won't be implemented
The goal of this connector is not to replaced the Gitea's web interface, so everything which is not Issue related or not link with what may help a developer in his day-to-day issues management
like Team/Repository management and milestone management will not be implemented.