Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "EGerrit/Contributor Guide"
(→Communication) |
|||
| (3 intermediate revisions by the same user not shown) | |||
| Line 21: | Line 21: | ||
= Obtaining Sources = | = Obtaining Sources = | ||
| − | EGerrit is | + | EGerrit is hosted in Git. You can browse the repository on the web: |
[http://git.eclipse.org/c/egerrit/org.eclipse.egerrit.git/ EGerrit] | [http://git.eclipse.org/c/egerrit/org.eclipse.egerrit.git/ EGerrit] | ||
| − | |||
| − | |||
| − | |||
| − | |||
= IDE configuration = | = IDE configuration = | ||
| + | * Clone the git repository | ||
| + | * Import the projects in Eclipse | ||
| + | * Set a target platform chosen from the org.eclipse.egerrit.target project | ||
= Running the tests = | = Running the tests = | ||
| − | The tests require a Gerrit server on which you can connect and commit. Don't worry, we have you covered. All you need to do is to install [https://docs. | + | The tests require a Gerrit server on which you can connect and commit. Don't worry, we have you covered. All you need to do is to install docker [https://docs.docker.com docker]. If you are Windows and Mac, make sure to get the native supports, it provides a nicer integration. |
| − | Once this is done, go to the org.eclipse.egerrit/org.eclipse.egerrit.releng folder and run " | + | Once this is done, go to the org.eclipse.egerrit/org.eclipse.egerrit.releng/gerritServers folder and run "./startContainers.sh" |
Once this is done, you can run the tests either from the IDE or by executing the Maven build. | Once this is done, you can run the tests either from the IDE or by executing the Maven build. | ||
= Plan = | = Plan = | ||
| − | + | At this point, we are planning to release a new version of EGerrit with each new version of the release train. | |
| + | You can find the list of previous releases [https://projects.eclipse.org/projects/technology.egerrit/ here]. | ||
| + | The best way to see what we are working on is to refer to our [https://tuleap.eclipse.org/plugins/agiledashboard/?group_id=102&action=showKanban&id=6#/kanban Kanban board] | ||
| + | |||
| + | = Build jobs = | ||
| + | The build jobs can be found at [https://hudson.eclipse.org/egerrit/ EGerrit on Hudson] | ||
= Contributing to the release train = | = Contributing to the release train = | ||
Contributions to the release trains are done in the simrel [http://git.eclipse.org/c/simrel/org.eclipse.simrel.build.git/ git repository]. | Contributions to the release trains are done in the simrel [http://git.eclipse.org/c/simrel/org.eclipse.simrel.build.git/ git repository]. | ||
| − | In the | + | In order to minimize the churn associated with contributing to the simrel repo, we are contributing our milestone repo until a date close to the final build of the release repo, at which point we change our contribution to point to a specific released build. |
| − | + | ||
| − | + | ||
For record, here is the initial commit adding EGerrit to the train: [https://git.eclipse.org/r/#/c/59589/] | For record, here is the initial commit adding EGerrit to the train: [https://git.eclipse.org/r/#/c/59589/] | ||
Note that in order to edit the simrel files, it is recommended to use the [https://www.eclipse.org/b3/download/ b3 aggregator editor] and consult [https://wiki.eclipse.org/Simrel/Contributing_to_Simrel_Aggregation_Build[ | Note that in order to edit the simrel files, it is recommended to use the [https://www.eclipse.org/b3/download/ b3 aggregator editor] and consult [https://wiki.eclipse.org/Simrel/Contributing_to_Simrel_Aggregation_Build[ | ||
Latest revision as of 11:48, 20 October 2016
| EGerrit | |
| Website | |
| Download | |
| Community | |
| Mailing List • Forums • IRC • mattermost | |
| Issues | |
| Open • Help Wanted • Bug Day | |
| Contribute | |
| Browse Source |
Contents
Communication
| Channel | EGerrit |
|---|---|
| Developer Mailing List | EGerrit developer mailing list |
| Reporting Bugs | File new EGerrit bug |
| User Forum | EGerrit Forum |
Obtaining Sources
EGerrit is hosted in Git. You can browse the repository on the web: EGerrit
IDE configuration
- Clone the git repository
- Import the projects in Eclipse
- Set a target platform chosen from the org.eclipse.egerrit.target project
Running the tests
The tests require a Gerrit server on which you can connect and commit. Don't worry, we have you covered. All you need to do is to install docker docker. If you are Windows and Mac, make sure to get the native supports, it provides a nicer integration. Once this is done, go to the org.eclipse.egerrit/org.eclipse.egerrit.releng/gerritServers folder and run "./startContainers.sh"
Once this is done, you can run the tests either from the IDE or by executing the Maven build.
Plan
At this point, we are planning to release a new version of EGerrit with each new version of the release train. You can find the list of previous releases here. The best way to see what we are working on is to refer to our Kanban board
Build jobs
The build jobs can be found at EGerrit on Hudson
Contributing to the release train
Contributions to the release trains are done in the simrel git repository. In order to minimize the churn associated with contributing to the simrel repo, we are contributing our milestone repo until a date close to the final build of the release repo, at which point we change our contribution to point to a specific released build. For record, here is the initial commit adding EGerrit to the train: [1]
Note that in order to edit the simrel files, it is recommended to use the b3 aggregator editor and consult [https://wiki.eclipse.org/Simrel/Contributing_to_Simrel_Aggregation_Build[