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.
Xtext/Contributor Guide
This page is currently under construction. Community members are encouraged to maintain the page, and make sure the information is accurate.
Contents
Prerequisites
User Account
We use eclipse gerrit review server. To use the review server a few steps are required:
- Register an Eclipse.org account at dev.eclipse.org. The same account is used for Bugzilla and Gerrit. If you are an Eclipse committer you already have one.
- Define a username
- Upload your public ssh-key for authentication
Eclipse Distribution
Download Full eclipse from Xtext website or use the eclipse DSL Package
Let Buckminster setup your Xcontributor environment
We provide an ant script which installs and runs Buckminster. Buckminster will do the most off necessary steps to crete a contributor workspace for you.
What does this script do in detail:
- create an eclipse workspace
- clone the Xtext git repository
- populate workspace with necessary projects
- create and set api baseline
- create and set a target platform
- set some important workspace settings
- perform gerrit setup
Run the script
Run the ant script located here. In unix you can use following commands:
wget -N http://git.eclipse.org/c/tmf/org.eclipse.xtext.git/plain/devtools/org.eclipse.xtext.contributor/workspace.ant; ant -f workspace.ant |
Start eclipse
Start your eclipse and choose ${user.home}/workspaces/xtext-sources as eclipse workspace
Setup working sets
- In "Package Explorer" - view, select "Top level elements -> Working sets"
- Select File -> Import -> Team -> Team Project Set.
- Point to the following URL http://git.eclipse.org/c/tmf/org.eclipse.xtext.git/plain/devtools/org.eclipse.xtext.contributor/projectSet.psf
- Perform import
Using git
As git client you may use whatever you want, the important thing is after setup your config looks like this:
[core]
repositoryformatversion = 0
filemode = true
logallrefupdates = true
[remote "origin"]
url = git://git.eclipse.org/gitroot/tmf/org.eclipse.xtext.git
pushurl = ssh://${bugzilla.user}@git.eclipse.org:29418/tmf/org.eclipse.xtext.git
fetch = +refs/heads/*:refs/remotes/origin/*
push = HEAD:refs/for/master
[branch "master"]
remote = origin
merge = refs/heads/master
Pulling changes from server
git pull origin master
Pushing to review server
git push origin master
Helpful sites
Contribution monitoring
After you pushed your first commit to gerrit, it will be reviewed on the hudson review server. If all tests pass a manuel review will be done by one of the Xtext committers. If all looks good, your contribution will be pushed to the master repository and you can install it from the regular eclipse hudson server.
Browse Sources Online
Xtext and Xtend are hosted in Git. You can browse the repository in cgit here Xtext/Xtend repository.