====== Overview of Evergreen Git Repositories ====== This document provides a basic outline of the git repositories available at [[https://git.evergreen-ils.org/]]. While the list on the server is not divided up into sections, we will do so here for the sake of discussion. It turns out that the listing as output by the standard ''Project'' sort can be divided //almost// neatly into 3 categories: - Release - Contrib - Working We will add a fourth category, "Miscellaneous," for the few oddball repositories that don't really fit in with the others. ===== Release Repositories ===== Release repositories are those from which the official, community releases of Evergreen, OpenSRF, and related software are made. They are the canonical sources of Evergreen code. Push access to these repositories is generally limited to the [[contributing:contributors#committers|core committers]]. ==== Evergreen.git ==== [[https://git.evergreen-ils.org?p=Evergreen.git;a=summary]] The main repository for the Evergreen ILS software. ==== Hatch.git ==== [[https://git.evergreen-ils.org?p=Hatch.git;a=summary]] The main repository for the Hatch web staff client add-on to enable automatic printing to different printers.. ==== NCIPServer.git ==== [[https://git.evergreen-ils.org?p=NCIPServer.git;a=summary]] The NCIP 2 server for Evergreen can be used to connect Evergreen to other resource sharing systems. ==== OpenSRF.git ==== [[https://git.evergreen-ils.org?p=OpenSRF.git;a=summary]] OpenSRF is the "backbone" of Evergreen, the message passing mechanism that enables it to run on multiple servers. ==== SIPServer.git ==== [[https://git.evergreen-ils.org?p=SIPServer.git;a=summary]] The SIPServer project provides a 3M SIP2 compatible server so that self-checks and other software can access Evergreen. ==== Syrup.git ==== [[https://git.evergreen-ils.org?p=Syrup.git;a=summary]] Syrup is a reserve book software for Evergreen, written in Python. ===== Contrib Repositories ===== The public ''contrib'' repositories are limited in who can push changes to the code. However, they are typically open to anyone to checkout, peruse, and used the code. Please pay attention to any license files included in the code. You should not assume that it is safe for you to redistribute the code or add it to other projects. ==== contrib/Conifer.git ==== [[https://git.evergreen-ils.org?p=contrib/Conifer.git;a=summary]] Modifications and contributions to Evergreen from the [[https://laurentian.concat.ca|Conifer consortium of Ontario academic and special libraries]]. ====contrib/equinox.git ==== [[https://git.evergreen-ils.org?p=contrib/equinox.git;a=summary]] A collection of miscellaneous tools, utilities, and examples that may be of interest to users of Evergreen, contributed by [[https://www.equinoxOLI.org/|Equinox Open Library Initiative]]. ==== contrib/governance.git ==== [[https://git.evergreen-ils.org?p=contrib/governance.git;a=summary]] A collection of governance documents relating to the Evergreen Oversight Board. ==== contrib/masslnc/vmscripts.git ==== [[https://git.evergreen-ils.org?p=contrib/masslnc/vmscripts.git;a=summary]] A collection of scripts from [[http://masslnc.org/|MassLNC]] to build virtual machine sandboxes for Bug Squashing Week and other testing. ==== contrib/mohawk.git ==== [[https://git.evergreen-ils.org?p=contrib/mohawk.git;a=summary]] Code for a tool to export Evergreen MARC records to Summon, contributed by [[https://www.mohawkcollege.ca/|Mohawk College]]. ==== contrib/overdrive-eg-opac.git ==== [[https://git.evergreen-ils.org?p=contrib/overdrive-eg-opac.git;a=summary]] A work-in-progress repository for Jeff Davis' Overdrive OPAC integration. ==== contrib/pines.git ==== [[https://git.evergreen-ils.org?p=contrib/pines.git;a=summary]] This repository contains [[https://georgialibraries.org/pines/|PINES]] utilities and other contributions for use with Evergreen. ==== contrib/pines/eg-debian.git ==== [[https://git.evergreen-ils.org?p=contrib/pines/eg-debian.git;a=summary]] Code to package Evergreen for Debian. ==== contrib/pines/genasys.git ==== [[https://git.evergreen-ils.org?p=contrib/pines/genasys.git;a=summary]] GenaSYS is an Evergreen cluster installation program developed by the [[https://www.georgialibraries.org/|Georgia Public Library Service]] and its contractors. ==== contrib/pines/osrf-debian.git ==== [[https://git.evergreen-ils.org?p=contrib/pines/osrf-debian.git;a=summary]] Code to package OpenSRF for Debian. ==== contrib/pines/report-creator.git ==== [[https://git.evergreen-ils.org?p=contrib/pines/report-creator.git;a=summary]] A quick report creator, contributed by PINES. ==== contrib/tadl.git ==== [[https://git.evergreen-ils.org?p=contrib/tadl.git;a=summary]] This repository will contain Evergreen-related contributions from the [[https://www.tadl.org/|Traverse Area District Library]]. It is currently empty. ===== Working Repositories ===== Working repositories are where most the development happens. This is work in progress and other code goes before being reviewed and added to one of the release repositories. When you [[dev:git#getting_commit_access_to_the_working_repositories|submit your ssh key]], you gain access to most of these repositories. Many of them have restricted access for who is allowed to push to them. ==== evergreen/bjwebb.git ==== [[https://git.evergreen-ils.org?p=evergreen/bjwebb.git;a=summary]] [[https://summerofcode.withgoogle.com/|Google Summer of Code]] student Benjamin Webb's Evergreen working repository. ==== evergreen/equinox.git ==== [[https://git.evergreen-ils.org?p=evergreen/equinox.git;a=summary]] This is an Evergreen tree maintained by employees of Equinox Open Library Initiative. ==== evergreen/joelewis.git ==== [[https://git.evergreen-ils.org?p=evergreen/joelewis.git;a=summary]] Working repository for Joseph Lewis, another Googles Summer of Code student. ==== evergreen/masslnc.git ==== [[https://git.evergreen-ils.org?p=evergreen/masslnc.git;a=summary]] Working repository for MassLNC. ==== evergreen/pines.git ==== [[https://git.evergreen-ils.org?p=evergreen/pines.git;a=summary]] Evergreen working repository for PINES. ==== evergreen/tadl.git ==== [[https://git.evergreen-ils.org?p=evergreen/tadl.git;a=summary]] Evergreen working repository for TADL. ==== opensrf/bjwebb.git ==== [[https://git.evergreen-ils.org?p=opensrf/bjwebb.git;a=summary]] OpenSRF working repository for Benjamin Webb. ==== syrup/masslnc.git ==== [[https://git.evergreen-ils.org?p=syrup/masslnc.git;a=summary]] A Syrup working repository for MassLNC. This work is mostly abandoned. ==== working/Evergreen.git ==== [[https://git.evergreen-ils.org?p=working/Evergreen.git;a=summary]] The community Evergreen working repository. Most new development happens here. ==== working/Hatch.git ==== [[https://git.evergreen-ils.org?p=working/Hatch.git;a=summary]] The community Hatch working repository. Most new development happens here. ==== working/NCIPServer.git ==== [[https://git.evergreen-ils.org?p=working/NCIPServer.git;a=summary]] The community NCIPServer working repository. Most new development happens here. ==== working/OpenSRF.git ==== [[https://git.evergreen-ils.org?p=working/OpenSRF.git;a=summary]] The community OpenSRF working repository. Most new development happens here. ==== working/SIPServer.git ==== [[https://git.evergreen-ils.org?p=working/SIPServer.git;a=summary]] The community SIPServer working repository. Most new development happens here. ==== working/random.git ==== [[https://git.evergreen-ils.org?p=working/random.git;a=summary]] The ''random'' repository contains a truly random collection of branches related to Evergreen. These include some people's conference presentations, installers, add-ons, or external modules that make use of Evergreen. None of the branches are necessarily related to each other or share files. Checking one branch out will usually completely replace the branch that you had checked out prior. ===== Miscellaneous ===== ==== Evergreen-DocBook.git ==== [[https://git.evergreen-ils.org?p=Evergreen-DocBook.git;a=summary]] An archive of the old, Evergreen documentation site. It is obsolete and kept around for historical reasons or just in case something is needed. ==== Evergreen_Website.git ==== [[https://git.evergreen-ils.org?p=Evergreen_Website.git;a=summary]] An archive of the old Evergreen website from before the move to Word Press. It's contents are obsolete, and it can be safely ignored. ==== history.git ==== [[https://git.evergreen-ils.org?p=history.git;a=summary]] This repository contains information related to the history of Evergreen. There's a single text file where collaborators can add one line descriptions of events in chronological order.