Source Code Repository
- Jessi Weithman
CollectionSpace's source code is managed via the open source Git version control system, in publicly-accessible repositories on the cloud-based GitHub application.
Prior to version 2.1, CollectionSpace's source code was managed via the Subversion (SVN) version control system, on a former, project-maintained SVN repository at source.collectionspace.org. Currently, the project's current code is maintained in GitHub, as noted above.
CollectionSpace Repositories
CollectionSpace's source code repositories are accessible via:
https://github.com/collectionspace/
There are repositories for all three layers of the CollectionSpace system:
There are also repositories for:
- Tools: auxiliary tools and scripts.
- Automated installer: The installer provides an Ansible playbook for setting up CollectionSpace on an Ubuntu server consistent with the official documentation.
- CSV Importer: A Rails webapp for importing CSV into CollectionSpace.
- Public Browser: A JavaScript application that runs in a web browser and provides public access to materials held in CollectionSpace.
Access to the Repositories
Consistent with the public status of work on the CollectionSpace project, all of the repositories are open for read-only, anonymous access.
Browsing Source Code Online
GitHub
GitHub's website offers an extensive set of tools for browsing source code, exploring and tracking changes, and more.
To get started, simply visit any of the project's repository pages linked above and start navigating through the source code directories. (To find a file by matching any part of its name, try the GitHub File Finder.)
JIRA Integration
There is a degree of integration between the project's source code repository and its /wiki/spaces/collectionspace/pages/666274563 system. For instance, any commits made to a repository whose comments begin with JIRA issue numbers will automatically be posted to the relevant JIRA issue(s). Examples:
To post details of a repository commit to JIRA Issue CSPACE-15:
CSPACE-15: Commit comment goes here ...
To post details of a repository commit to two JIRA issues, Issue CSPACE-15 and Issue CSPACE-21:
CSPACE-15,CSPACE-21: Commit comment goes here ...
To post details of a repository commit that doesn't involve a JIRA issue:
NOJIRA: Commit comment goes here ...
Licensing
CollectionSpace is licensed under the Educational Community License (ECL), Version 2.0, an open source license. For details, see /wiki/spaces/collectionspace/pages/666275129.
Javadoc Documentation for the Source Code
Javadoc documentation is currently available for the Services Layer source code at http://nightly.collectionspace.org/apidocs/services