Go to file
François TERROT 9322d65b8b
Deploy GPG public signature file.
Signed-off-by: François TERROT <fterrot@april.org>
2021-04-18 11:58:11 +02:00
.gitignore Initial commit 2021-02-08 11:18:52 +01:00
2A766910298F3874.asc Deploy GPG public signature file. 2021-04-18 11:58:11 +02:00
LICENSE Switch to MIT License. 2021-03-06 19:13:21 +01:00
README.md updates 2021-02-28 15:16:35 +01:00

README.md

mylyn-gitea

Gitea Mylyn Connector : Gitea Issues management for Eclipse/Mylyn.

This Mylyn connector will allow you to connect Mylyn to a Gitea instance (self hosted or not) in order to manage your issues on Gitea with your local Eclipse instance.

Thanks and Credits

I want to thanks and credit:

Changes

  • 08.02.2021 - I'm currently working to make the connector working, resolving package and installation issues (plugins 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 og 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

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 web interfac, so everything which is not Issue related or not link with what may help a developper in his day-to-day issue management will not be implemented, typically Team/Repository management and milestone management.

Usage

  1. Install the plugin obviously (you can use the https://github.com/teilginn/mylyn-gitea update site)
  2. Add a new Connector, using the new Gitea Connector
  3. enter the project URL (something like http(s)://my-gitea-instance.org/myname_or_organisation/myrepository)
  4. enter your usename and your password
  5. Do not forget to check the "Save Password" checkbox. I don't know how to create a password prompt...
  6. You can now create queries and issues

If you use https instead of http (and you absolutely should use https), be sure you have a valid certificate. That means it is signed by a trusted CA. If you don't have a valid certificate (like a self signed certificate), the plugin will refuse to connect. If you want to add your CA certificate to the java keystore, you have to:

  1. find the keystore which is used by your JVM (on my machine it is /etc/ssl/certs/java/cacerts)
  2. find out the password for the keystore (the default is "changeit")
  3. add the CA certificate to this keystore
  4. On Linux, Mac OS X, or Unix systems, use keytool -import -alias A-UNIQUE-ALIAS -file YOUR-CA.crt -keystore $PATH_TO_YOUR_KEYSTORE (root permissions may be necessary)
  5. On Windows, in an Administrator Command Prompt use "%PROGRAMFILES%\java\jre7\bin\keytool" -import -alias A-UNIQUE-ALIAS -file YOUR-CA.cer -keystore "%PROGRAMFILES%\Java\jre7\lib\security\cacerts"

I don't kown if I will introduce the option to ignore certificate errors. It is not a good way to do those kind of things, especially as it's now not so difficult to get a valid certificate for self hosted services thanks to Let's Encrypt.

Known issues/Limitations

  • List of Eclipse versions plugins is compliant with, is to be defined. It will be test with the version of Eclipse I'm using (Linux/Windows) in front of an always up to date gitea instance.
  • Version 1.x will only support read acess and queries, we have may to wait the Version 2.x to create and modify issues.
  • If you created a new milestone or added a new project member via the web interface, you have to update the repository configuration, so that the connector reloads the project members and milestones. Right click on the Gitea repository in the Task repositories view and click on "Update Repository Configuration".
  • Offline mode does not work.
  • Out of the box support for valid certificates only.
  • Ssl connection issue with some servers