Skip to content

Commit ae0c192

Browse files
sblivenandreasprlic
authored andcommitted
Major rewrite to reflect github migration
1 parent ce94422 commit ae0c192

2 files changed

Lines changed: 115 additions & 88 deletions

File tree

_wikis/Get_source.md

Lines changed: 68 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -2,73 +2,77 @@
22
title: Get source
33
---
44

5-
Check out code from SVN
6-
=======================
5+
BioJava is hosted on [Github](https://github.com/biojava/biojava/). The
6+
preferred method for checking out the source is with git, although it is
7+
also possible to use subversion.
78

8-
BioJava requires [Subversion](http://subversion.tigris.org/) (SVN) and
9-
[Maven](http://maven.apache.org/) for checking out the code and creating
10-
a build. Access is possible either via
9+
Getting the latest release code
10+
===============================
1111

12-
`- Anonymous SVN or GIT access or`
13-
`- Developer SVN access (ssh account required) or`
14-
`- BioJava SNAPSHOT builds (anonymous, Maven required)`
12+
BioJava can be accessed several ways
1513

16-
Downloading and updating code via Anonymous SVN
17-
===============================================
14+
- Git
15+
- SVN (not recommended)
16+
- [Download binaries](BioJava:Download "wikilink")
17+
- Directly from [Maven](http://maven.apache.org/)
1818

19-
The code.open-bio.org server offers up read-only copies of source code
20-
repositories via anonymous SVN. A list of code repositories available
21-
via SVN can be seen here: <http://code.open-bio.org/?root=biojava>
19+
Using git
20+
---------
2221

23-
### Checking out the latest BioJava code
22+
The latest stable release version of BioJava is available through git
23+
using the following command:
2424

25-
The following example shows how to obtain the latest BioJava codebase
26-
snapshot using anonymous SVN, it will check out the latest copy of
27-
biojava-live/ from the "SVN trunk" and will locally store it in a
28-
directory named "biojava" on your system:
25+
`git clone `[`https://github.com/biojava/biojava.git`](https://github.com/biojava/biojava.git)
2926

30-
`svn co `[`http://code.open-bio.org/repos/biojava/biojava-live/trunk`](http://code.open-bio.org/repos/biojava/biojava-live/trunk)` ./biojava`
31-
32-
Anonymous checkouts are now hosted at [read only mirror at
33-
github](http://github.com/biojava/biojava). As such you can of course
34-
also use git to get a copy of the code:
27+
This can also be done directly from within Eclipse. Instructions are
28+
available at [BioJava3 eclipse](BioJava3 eclipse "wikilink").
3529

36-
`git clone `[`https://github.com/biojava/biojava.git`](https://github.com/biojava/biojava.git)
30+
Using SVN
31+
---------
3732

38-
finally there is also a SVN interface to github:
33+
If you prefer to use SVN, code can also be accessed using Github's SVN
34+
bridge.[1](https://github.com/blog/1178-collaborating-on-github-with-subversion)
3935

4036
`svn co `[`http://svn.github.com/biojava/biojava.git`](http://svn.github.com/biojava/biojava.git)` ./biojava`
4137

42-
A list of all available projects in SVN can be obtained with:
38+
Maven Release builds
39+
--------------------
4340

44-
`svn list `[`http://code.open-bio.org/repos/biojava`](http://code.open-bio.org/repos/biojava)
41+
In order to use BioJava in your Maven projects, add the following lines
42+
to your project .pom file:
4543

46-
### Troubleshooting Anonymous SVN
44+
<repositories>
45+
<repository>
46+
<id>biojava-maven-repo</id>
47+
<name>BioJava repository</name>
48+
<url>http://www.biojava.org/download/maven/</url>
49+
<releases>
50+
<enabled>true</enabled>
51+
</releases>
52+
</repository>
53+
</repositories>
54+
55+
You can then add any of the biojava modules as a dependency for your
56+
project and Maven will automatically fetch the relevant jar files.
4757

48-
If you encounter an error while using the SVN client or SVN Web
49-
interface, the likely cause is that our server is in the middle of
50-
replicating the repository from the primary source. While the mirror and
51-
replication process occurs, it is not unusual for SVN client
52-
functionality to break temporarily.
58+
Getting the latest development code
59+
===================================
5360

54-
The final step of our codebase replication process is to explicitly
55-
re-verify the health and status of each repository, this process takes a
56-
few moments but while it occurs the repository is "locked" and
57-
unavailable for access.
61+
BioJava generally releases two to three times a year. To get the latest
62+
features and bug fixes, you can use the devel branch.
5863

59-
`   * Anonymous SVN repositories are updated/mirrored hourly from the primary developer server`
60-
`   * Anonymous SVN repositories are verified and repaired (if necessary) every 20 minutes `
64+
` git clone -b devel `[`https://github.com/biojava/biojava.git`](https://github.com/biojava/biojava.git)
6165

62-
If a SVN client error occurs for longer than 20 minutes, please report
63-
this to: support@helpdesk.open-bio.org
66+
or from an existing git repository
6467

65-
For Eclipse Users
66-
=================
68+
`git checkout devel`
6769

68-
`For more details on how to setup eclipse plugins needed and to checkout Biojava code, see `[`BioJava3_eclipse`](BioJava3_eclipse "wikilink")`.`
70+
All developers should use the devel branch for publishing changes.
71+
Details for how to contribute changes back to BioJava are available at
72+
[Developer\_Code\_Access](Developer_Code_Access "wikilink").
6973

7074
Maven SNAPSHOT builds
71-
=====================
75+
---------------------
7276

7377
BioJava now also provides SNAPSHOT builds of the latest code base. This
7478
is created automatically by the automated build system at
@@ -90,22 +94,29 @@ the following lines to your project .pom file:
9094
</repository>
9195
</repositories>
9296

93-
Downloading and updating code via Developer SVN
94-
===============================================
97+
History
98+
=======
99+
100+
At its conception, BioJava was stored on a CVS repository and built
101+
using Ant. Since then, several major refactoring have occurred leading
102+
to the current layout as a set of Maven modules stored on github.
95103

96-
For getting write access to BioJava you need a developer account on
97-
dev.open-bio.org. Details for how developers can check out the
98-
read/write enabled SVN see at
99-
[Developer\_Code\_Access](Developer_Code_Access "wikilink")
104+
BioJava migrated to Git
105+
-----------------------
100106

101-
Links
102-
=====
107+
BioJava was migrated to git in April 2013 (see [SVN to GIT
108+
Migration](SVN to GIT Migration "wikilink")). History prior to September
109+
2009 was not migrated. The old SVN repositories are still available for
110+
anonymous SVN access, but are closed to new commits. The repository can
111+
be [browsed online](http://code.open-bio.org/?root=biojava) or checked
112+
out using
113+
114+
`svn co `[`http://code.open-bio.org/repos/biojava/biojava-live/trunk`](http://code.open-bio.org/repos/biojava/biojava-live/trunk)` ./biojava`
103115

104-
See also the [SVN developers page in the OBF
105-
wiki](http://www.open-bio.org/wiki/SVN-Developers)
116+
Developers who previously had write access to SVN can also view the
117+
archive at the old development server (requires ssh access)
106118

107-
Repository News
108-
===============
119+
`svn co svn+ssh://dev.open-bio.org/home/svn-repositories/biojava/biojava-live/trunk/ ./biojava-live`
109120

110121
BioJava migrated to Maven
111122
-------------------------

_wikis/Get_source.mediawiki

Lines changed: 47 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,59 @@
1-
=Check out code from SVN=
1+
BioJava is hosted on [https://github.com/biojava/biojava/ Github]. The preferred method for checking out the source is with git, although it is also possible to use subversion.
22

3-
BioJava requires [http://subversion.tigris.org/ Subversion] (SVN) and [http://maven.apache.org/ Maven] for checking out the code and creating a build. Access is possible either via
4-
- Anonymous SVN or GIT access or
5-
- Developer SVN access (ssh account required) or
6-
- BioJava SNAPSHOT builds (anonymous, Maven required)
3+
=Getting the latest release code=
74

8-
= Downloading and updating code via Anonymous SVN =
5+
BioJava can be accessed several ways
6+
* Git
7+
* SVN (not recommended)
8+
* [[BioJava:Download|Download binaries]]
9+
* Directly from [http://maven.apache.org/ Maven]
910
10-
The code.open-bio.org server offers up read-only copies of source code repositories via anonymous SVN. A list of code repositories available via SVN can be seen here: http://code.open-bio.org/?root=biojava
11+
==Using git==
1112

12-
===Checking out the latest BioJava code===
13+
The latest stable release version of BioJava is available through git using the following command:
1314

14-
The following example shows how to obtain the latest BioJava codebase snapshot using anonymous SVN, it will check out the latest copy of biojava-live/ from the "SVN trunk" and will locally store it in a directory named "biojava" on your system:
15+
git clone https://github.com/biojava/biojava.git
1516
16-
svn co http://code.open-bio.org/repos/biojava/biojava-live/trunk ./biojava
17+
This can also be done directly from within Eclipse. Instructions are available at [[BioJava3 eclipse]].
1718

18-
Anonymous checkouts are now hosted at [http://github.com/biojava/biojava read only mirror at github]. As such you can of course also use git to get a copy of the code:
19+
==Using SVN==
1920

20-
git clone https://github.com/biojava/biojava.git
21-
22-
finally there is also a SVN interface to github:
21+
If you prefer to use SVN, code can also be accessed using Github's SVN bridge.[https://github.com/blog/1178-collaborating-on-github-with-subversion]
2322

2423
svn co http://svn.github.com/biojava/biojava.git ./biojava
2524
25+
== Maven Release builds ==
2626

27-
A list of all available projects in SVN can be obtained with:
28-
29-
svn list http://code.open-bio.org/repos/biojava
27+
In order to use BioJava in your Maven projects, add the following lines to your project .pom file:
3028

29+
<pre>
30+
<repositories>
31+
<repository>
32+
<id>biojava-maven-repo</id>
33+
<name>BioJava repository</name>
34+
<url>http://www.biojava.org/download/maven/</url>
35+
<releases>
36+
<enabled>true</enabled>
37+
</releases>
38+
</repository>
39+
</repositories>
40+
</pre>
41+
42+
You can then add any of the biojava modules as a dependency for your project and Maven will automatically fetch the relevant jar files.
3143

32-
===Troubleshooting Anonymous SVN===
44+
= Getting the latest development code =
3345

34-
If you encounter an error while using the SVN client or SVN Web interface, the likely cause is that our server is in the middle of replicating the repository from the primary source. While the mirror and replication process occurs, it is not unusual for SVN client functionality to break temporarily.
46+
BioJava generally releases two to three times a year. To get the latest features and bug fixes, you can use the devel branch.
3547

36-
The final step of our codebase replication process is to explicitly re-verify the health and status of each repository, this process takes a few moments but while it occurs the repository is "locked" and unavailable for access.
48+
git clone -b devel https://github.com/biojava/biojava.git
3749
38-
* Anonymous SVN repositories are updated/mirrored hourly from the primary developer server
39-
* Anonymous SVN repositories are verified and repaired (if necessary) every 20 minutes
50+
or from an existing git repository
4051

41-
If a SVN client error occurs for longer than 20 minutes, please report this to: support@helpdesk.open-bio.org
52+
git checkout devel
4253
43-
=For Eclipse Users=
44-
For more details on how to setup eclipse plugins needed and to checkout Biojava code, see [[BioJava3_eclipse]].
54+
All developers should use the devel branch for publishing changes. Details for how to contribute changes back to BioJava are available at [[Developer_Code_Access]].
4555

46-
= Maven SNAPSHOT builds =
56+
== Maven SNAPSHOT builds ==
4757

4858
BioJava now also provides SNAPSHOT builds of the latest code base. This is created automatically by the automated build system at [http://emmy.rcsb.org:8080/cruisecontrol/
4959
]. In order to install .jar files from this repository automatically for your Maven projects, add the following lines to your project .pom file:
@@ -65,14 +75,20 @@ BioJava now also provides SNAPSHOT builds of the latest code base. This is creat
6575
</pre>
6676

6777

68-
= Downloading and updating code via Developer SVN =
78+
=History=
79+
80+
At its conception, BioJava was stored on a CVS repository and built using Ant. Since then, several major refactoring have occurred leading to the current layout as a set of Maven modules stored on github.
81+
82+
==BioJava migrated to Git==
83+
84+
BioJava was migrated to git in April 2013 (see [[SVN to GIT Migration]]). History prior to September 2009 was not migrated. The old SVN repositories are still available for anonymous SVN access, but are closed to new commits. The repository can be [http://code.open-bio.org/?root=biojava browsed online] or checked out using
85+
86+
svn co http://code.open-bio.org/repos/biojava/biojava-live/trunk ./biojava
6987
70-
For getting write access to BioJava you need a developer account on dev.open-bio.org. Details for how developers can check out the read/write enabled SVN see at [[Developer_Code_Access]]
88+
Developers who previously had write access to SVN can also view the archive at the old development server (requires ssh access)
7189

72-
= Links =
73-
See also the [http://www.open-bio.org/wiki/SVN-Developers SVN developers page in the OBF wiki]
90+
svn co svn+ssh://dev.open-bio.org/home/svn-repositories/biojava/biojava-live/trunk/ ./biojava-live
7491
75-
=Repository News=
7692
==BioJava migrated to Maven==
7793

7894
BioJava has migrated to Maven and was re-organized into sub-modules. For more information see [[BioJava:MavenMigration]]

0 commit comments

Comments
 (0)