GitHub

Document created by resplin Employee on Mar 14, 2015
Version 1Show Document
  • View in full screen mode

The official Alfresco source tree is in Subversion. The page Alfresco SVN Development Environment contains instructions for accessing the official Subversion repository.

Many members of the Alfresco community prefer to use GitHub to collaborate around code. This makes it easy to fork the code of Alfresco Community Edition, make improvements, and share them with others. To facilitate this collaboration, we maintain an official mirror of many Alfresco projects in GitHub:


Not all projects in Alfresco SVN are mirrored to GitHub. You might need to get some directly from SVN. Let us know if you want us to mirror additional repositories.

There are some things to keep in mind when using these repositories:


  • Alfresco support does not provide official support for this repository.
  • Alfresco engineering does not use this repository.
  • Issues for Alfresco community edition should be logged in [the issue tracker].
  • We will not be accepting pull requests into the GitHub repositories. If you want to contribute a change, fork the repository and prepare your pull request, then please log an issue in Alfresco JIRA referencing the pull request. If your patch is accepted, it will be committed to SVN head, and later flow into the GitHub mirror.
  • GitHub recommends keeping repositories under 1GB in size, otherwise the repo gets hard to clone. GitHub also recommends keeping individual files under 50MB. For this reason, large files are replaced with a text message referencing Subversion, and large repositories have the history truncated.
    • As a point of reference from April 2014, the complete export from Subversion to a local Git repository is 3.3GB. An export of only a the most recent SVN revision is 1.5G.
    • For this reason, large repositories have their history truncated. Older commit history are available in Subversion.
    • We run a a tool to delete large files from the history. If you need a file in the repository whose name is <filename>.REMOVED.git-id, then it is a large file and you should get it directly from Alfresco Subversion.
  • The GitHub mirror is refreshed from the Subversion repo once per day, early morning GMT.

Building from a Github clone


There are currently in the default ant build script dependencies on the clone being a subversion clone. There is an issue filed for this ALF-20943. In this issue there is an alternative build file named github.xml that will fix the build issues. Download this file and place it the source root. You can then build with
ant -f github.xml distribute

Source ControlContributingCommunity

1 person found this helpful

Attachments

    Outcomes