WIP - update README.MD
This commit is contained in:
parent
e7b73155c6
commit
c79d8c3cfa
GPG Key ID:
7D96B088C27AC869
72
README.md
72
README.md
@ -1,49 +1,39 @@
|
||||
# mylyn-gitea
|
||||
# Mylyn/Gitea Tasks Connector
|
||||
|
||||
Mylyn/Gitea Tasks Connector : Gitea's issues management for Eclipse/Mylyn.
|
||||
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 update site for the Mylyn/Gitea Tasks Connector plug-in is https://teilginn.github.io/mylyn-gitea-updatesite/.
|
||||
* 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
|
||||
|
||||
## Thanks and Credits
|
||||
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, the "Mylyn Gitlab Connector" 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.
|
||||
* 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.
|
||||
|
||||
## Changes
|
||||
|
||||
* 08.02.2021 - I'm currently working to make the connector working, resolving package and installation issues (plug-ins crash on eclipse start due to missing class Exception), then I will debug basic features (repository connectorion ...) before I will upload first code and binaries.
|
||||
* 28.02.2021 - First connector version is working in debug in front of https://forge.chapril.org. I still have maven/jdk 11 generation issue. So I switch to a newly generated "Java Gitea API", OpenAPI based.
|
||||
|
||||
|
||||
## Planned Features
|
||||
|
||||
### Version 0.1.x - prove of concept
|
||||
|
||||
- [ ] use basic (user,password) or token authentication (preferred)
|
||||
- [ ] list and query for issues
|
||||
- [ ] handles issues on a repository basis
|
||||
- [ ] installation though update site
|
||||
|
||||
### Planned features
|
||||
|
||||
- [ ] edit issue - add comment on issues
|
||||
- [ ] edit issue - close/reopen issue
|
||||
- [ ] edit issue - change assignee list, labels, project, milestone
|
||||
- [ ] create issue
|
||||
- [ ] enhance query hmi - labels selection per list
|
||||
|
||||
### Missing features
|
||||
|
||||
* Password prompt (I just don't know how...)
|
||||
|
||||
### 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.
|
||||
* 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
|
||||
|
||||
@ -54,13 +44,15 @@ see (Mylyn/Gitea Tasks Connector plug-ins update site)[https://forge.chapril.org
|
||||
* [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)
|
||||
|
||||
## Report an issue
|
||||
|
||||
To avoid any account management activity, issues tracker is handled at [Github](https://github.com/teilginn/mylyn-gitea/issues).
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user