Evergreen DokuWiki - dev

2017_new_tools

Anonymous (anonymous@undisclosed.example.com) — 2023-06-22T13:10:55+00:00

Replacement of Launchpad and/or Gitolite in 2017 We have been using Launchpad for several years for bug/feature request tracking and managing our translations. Separately, we have been using Gitolite and Gitweb to manage our Git repositories. However, some dissatisfaction has been building up over the years, and during the hackfest at the 2017 EIC, we decided to start exploring alternatives.

angular_dev_best_practices

Anonymous (anonymous@undisclosed.example.com) — 2024-09-15T17:03:31+00:00

Evergreen Angular Development Best Practices Work in progress. Loose collection of practices to review with developers so we can agree on UI developer guidelines. Code quality * Run 'ng build --prod' before committing. * This ensures the templates also compile successfully.

auxiliary_supplementary_code

Anonymous (anonymous@undisclosed.example.com) — 2023-02-15T18:06:11+00:00

Auxiliary/supplementary Evergreen code Here we try to keep track of any useful Evergreen-related projects. Things like import/export data. Or anything else that cannot be found directly in the Evergreen git repository. Exports * LibraryIQ export * CollectionHQ export * Above The Treeline export * Message Bee XML export

bug_squashing

Anonymous (anonymous@undisclosed.example.com) — 2026-04-23T18:11:54+00:00

Evergreen Bug Squashing Week Introduction The goal of Bug Squashing Week is for contributors and volunteers to commit time throughout the week to the following activities: * Fixing bugs; * Testing bug fixes that have pullrequest tags; * General bug wrangling activities (confirming bugs, marking duplicates, etc.);

code_repositories

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Known locations for Evergreen and OpenSRF source code repositories You might want to start with procedures and conventions for contributing to the Evergreen project if you want to learn more about the process of becoming an Evergreen developer. As we transition into an environment with a distributed set of code repositories, this page is an attempt to point to locations of code pertinent to Evergreen. You don't need to contribute to Evergreen if you're interested in our code - but it would be …

code_review

Anonymous (anonymous@undisclosed.example.com) — 2025-09-04T16:31:56+00:00

Code Review Meetings Open pull requests without needs-* tags: Critical PRs | High priority PRs Modules * Administration * Acquisitions * Booking * Cataloging * Circulation * Courses * Reports * OPAC Infrastructure * Translations * Efficiency / performance * Database * Permissions * IDL * Staff columns issues are usually IDL-related; otherwise grid * Grid * Combobox * Accessibility * Staff + dark mode * Staff + everything else * OPAC * Clea…

committing

Anonymous (anonymous@undisclosed.example.com) — 2023-11-09T23:30:37+00:00

Guide to committing This is a guide for core committers of Evergreen. Committing patches with database upgrade scripts * Confirm that there are no unintended side effects to the upgrade script (data loss, performance issues, etc.) * Figure out the next number in the upgrade script sequence.

configuration

Anonymous (anonymous@undisclosed.example.com) — 2022-05-02T01:26:19+00:00

Evergreen has numerous different types of settings, which are stored in different places and accessed in different ways. Each type of setting is useful in certain circumstances. This page attempts to explain how and why you might use each one. OpenSRF settings

contributing_code_faq

Anonymous (anonymous@undisclosed.example.com) — 2023-06-01T16:01:53+00:00

Contributing Code FAQs * What version control system do you use? * We use git at https://bugs.launchpad.net/evergreen and offer access to the "working" Evergreen repository to anyone who sends in an SSH key. We ask that you create "topic branches" based against main for each feature you want to contribute and keep them separated, if you can. Also, please open a bug at bugs.launchpad.net/evergreen and point at your branch when you're ready to have it reviewed. More info on how we use …

contributing_code

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Contributing code Want to develop for Evergreen or OpenSRF? Great! To get started, please take a look at * the overview of how to contribute to Evergreen, covering tips, techniques, and procedures for getting your code and documentation accepted * version control repositories for code and documentation * new developer wishlist where a group of us are identifying what documentation needs to be developed to support new developers(some of the drafts of documentation being developed are …

customizing_ttpac

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

TTPac Customization Quick-start CSS TTPac utilizes CSS throughout to provide easy customization of various elements throughout the OPAC. There are two main CSS files with which you'll want to customize, found in: /openils/var/web/css/skin/default/opac/style.css /openils/var/web/css/skin/default/opac/semiauto.css

database_schemas

Anonymous (anonymous@undisclosed.example.com) — 2024-12-20T17:49:11+00:00

* 3.14 Evergreen Database Schema (Schemaspy LARL Unofficial) * 3.13 Evergreen Database Schema (Schemaspy LARL Unofficial) * 3.12 Evergreen Database Schema (Schemaspy LARL Unofficial) * 3.11 Evergreen Database Schema (Schemaspy LARL Unofficial) * 3.10 Evergreen Database Schema (EG Wiki) * 3.2 Evergreen Database Schema (Old Docs Site) * 3.1 Evergreen Database Schema (Old Docs Site) * 3.0 Evergreen Database Schema (Old Docs Site) * 2.12 Evergreen Database Schema (Old Docs Site)…

eg-combobox

Anonymous (anonymous@undisclosed.example.com) — 2025-04-02T19:59:57+00:00

The Combobox Component WIP page. TODO: * usage * events * keyboard * eg-org-select is not a complete clone of eg-combobox * open combobox bugs Keyboard Events added to eg-combobox and eg-org-select as part of the Item Alerts, Notes, Tags, and Templates Rework (bug 2074112). There are new event emitters to allow keyboard shortcuts in general, and there is a specific one for the Enter key where the selected value is emitted.

eg-grid

Anonymous (anonymous@undisclosed.example.com) — 2025-03-04T17:42:30+00:00

Angular eg-grid component Setting up a new grid * Defining the persistKey and adding the workstation setting SQL for saving grid settings * Choosing the data source and setting up GridDataSource.getRows() * Fleshing linked fields * Handling linked fields using CStore when PCRUD is not available (i.e. org unit settings)

email

Anonymous (anonymous@undisclosed.example.com) — 2023-10-19T13:47:29+00:00

Testing email interactions in a development environment Evergreen sends emails as part of several of its processes. If you are working with one of these processes, and want to validate your changes locally, you have several options. The easiest option: using a localhost email address and mutt

feedback_fest_2020-02

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

February 2020 Feedback Fest Week Dates: February 17-21, 2020 Activities Many thanks to everyone who participated in Feedback Fest! Special thanks to Chris Sharp, Blake Graham-Henderson, and Bill Erickson, who made sandboxes available for testing throughout the week.

feedback_fest_2020-08

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

August 2020 Feedback Fest Week Dates: August 17-21, 2020 Activities Many thanks to everyone who participated in Feedback Fest! Stats * Signoffs: 28 * Patches Committed: 19 * Patches New/Rebased/Updated: 33 * New Bug Reports: 19 * Other Feedback:

feedback_fest_2021_08

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

August 2021 Feedback Fest Week Dates: August 9-13, 2021 Activities Many thanks to everyone who participated in Feedback Fest! We broke the record for how many patches and features were tested and signed off on, as well as the record for how many signed off patches and features were committed to core Evergreen!

git_overview

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Overview of Evergreen Git Repositories This document provides a basic outline of the git repositories available at . 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

git

Anonymous (anonymous@undisclosed.example.com) — 2025-04-15T17:22:46+00:00

Git Evergreen uses Git as its primary version control system for both code and documentation. A number of repositories of interest to Evergreen, including the main public repositories for Evergreen, Evergreen's documentation, and OpenSRF, are maintained on the

glossary

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

The following glossary is intended for persons wishing contribute to the development of Evergreen. It currently focuses on terms specific to the OpenSRF and Evergreen projects. BibTemplate DojoSRF Fieldmapper fm_IDL.xml OpenSRF (pronounced "Open Surf")

historic_articles

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

OpenSRF, the framework underlying Evergreen * Blog entry: The birth of OpenSRF

lp_tags

Anonymous (anonymous@undisclosed.example.com) — 2025-12-15T19:36:53+00:00

Evergreen Launchpad Tags This is a list of official Evergreen Launchpad tags. Tags and tag definitions reflect community practice and can shift over time. Please feel free to edit this list as needed. Tags with asterisks reflect special community use, described

meetings

Anonymous (anonymous@undisclosed.example.com) — 2026-04-24T14:09:00+00:00

Development Meetings [IRC] The Development Meeting is a public meeting held on the #evergreen channel on the Libera IRC network (available through an IRC client or the web gateway). All members of the community with an interest in contributing to the development of Evergreen are welcome to attend.

miker-git-svn

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

NOTE: This is a workflow for committers. The good news is that non-committer git-svn is simpler still! First, some helpful bash aliases Adjust to taste, of course, but alias show='for i in `git remote show`; do git remote show $i; done' alias dif='git diff' alias co='git checkout' alias ci='git checkin' alias branch='git branch' alias status='git stat' alias upall='for i in `branch|colrm 1 2|grep -vf ~/.dead-git-branches`; do co $i; git pull; done'

new_developer_wishlist

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Quicklinks to Contributions Pertinent to our Wish List Below * This is our starting point: code_contribution * Also see Using git * Also see Dan Scott's tutorial on developing the TPAC at * New Stuff * Evergreen Developer Overview (initial draft provided by Thomas Berezansky) Wish List Items/Discussion

opensrf_roadmap

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

OpenSRF Development Roadmap OpenSRF 3.1 Project release date: 2018-10-15 Desired features Please add links to Launchpad bugs or descriptions of potential new features that are in progress or can reasonable be expected to be done by mid-September or so.

post_2.0_planning

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Post 2.0 planning/development landing page

release_notes_checklist

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Checklist for Evergreen release notes Since a raw ChangeLog won't really do as release notes for anything except a tiny minor release of Evergreen, here's a list of items to include when compiling notes for a major release. * Installation/upgrade requirements and changes

release_process

Anonymous (anonymous@undisclosed.example.com) — 2024-02-02T00:57:14+00:00

Processes for releasing Evergreen and OpenSRF The steps for creating the files for a given release of Evergreen and OpenSRF are documented on the following pages: * Evergreen - additional checklist * OpenSRF

resolver

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Getting real-time holdings from an OpenURL resolver The open-ils.resolver service queries an OpenURL resolver for a given ISSN or ISBN and returns the full-text holdings coverage with URLs available for that material. This is useful if, for example, a patron searches for the "Journal of Brains" and you want to immediately provide links to the electronic resources where the resolver knows that your content is available. As some OpenURL resolvers take a long time (in Web seconds) to return respon…

search_changes

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

This is a collection of proposed changes to searching. None of it is guaranteed to happen and it is all subject to revision. Database changes Table Changes Create metabib.combined_*_field_entry tables: * record - FK to biblio.record_entry * metabib_field - FK to config.metabib_field, nullable

security

Anonymous (anonymous@undisclosed.example.com) — 2023-06-01T17:22:55+00:00

How the Evergreen Project Handles Security-related Bugs How do I report a security-related issue in Evergreen? You can report a security-related issue in Evergreen via the bug tracking system at -- be sure to check the box labeled "This bug is a security vulnerability".

server_print_templates

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Server Print Templates What's the Problem? * Templates whose syntax depends on the UI framework creates inconsistency and is not sustainable. * Angular templates must be pre-compiled. * Template modification requires local install and use of 'ng build'.

signoff_review_checklist

Anonymous (anonymous@undisclosed.example.com) — 2022-09-15T14:16:34+00:00

Signoff / review checklist Yes/No Item Have you run make check && make livecheck with zero failed tests? If the patch adds or modifies a stored procedure, is it accompanied by pgTAP unit and/or regression tests? If not, has the patch author provided an explanation as to why such a test cannot be feasibly written? (Also, an additional signoff will be required.)

sqitch

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Using Sqitch with Evergreen See alsoLaunchpad Bug 1521693 Getting Started Install Sqitch # Works on most systems. See sqitch.org for more. $ sudo cpan App::Sqitch Install Base Schema Install the latest working branch from LP 1521693 using the standard DB install process. The branch is set up to use Sqitch internally. No special considerations are required for the base install.

standing_dco

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Standing Developer's Certificate of Origin DCO Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit …

start

Anonymous (anonymous@undisclosed.example.com) — 2025-08-11T19:16:56+00:00

Evergreen and OpenSRF development * Evergreen code repositories * New Developers Working Group documentation * Wish list of documentation needed for new developers * Code Review team Potential replacement of Launchpad in 2017 Processes * Process for adding a new core committer Recommended reading * Procedures and conventions for contributing to the Evergreen project Dan Scott has been working on an excellent developer's tutorial, located here:

test_writing_day

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Evergreen Test Writing Days During an Evergreen Test Writing Day, people in the community gather on IRC to write tests, which can be used to help determine if code is functioning correctly. In general, the code takes values that are both valid and invalid. In the case of valid values, the expectation is that the code does the task designed, and the tests should output information confirming or denying this. In the case of invalid input, the tests should indicate failure.

testing_code

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Testing Code The Evergreen community can always use help from volunteers willing to test newly-contributed code. These Evergreen bug fixes and code for new features are ready for testing. According to community guidelines, each piece of new code needs to be tested and get a sign-off from somebody else before it can be merged into Evergreen

tools

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Introduction Development tools can be placed here, these tools may have been in the scratch-pad already, but shouldn't actually be added to the repos because their use is not often needed, especially by end users. Tool List * Web Report Generator (Shows which files depend upon which other files in the web root, useful for Dojo upgrades/checking changes)

xul_memory_consumption

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Request for help - template To: Evergreen general mailing list From: Evergreen developers Subject: Staff client memory issues in 2.3+ - we need your help! Hi, recently it was brought to our attention that some (but not all) libraries that have upgraded to Evergreen 2.3 are running into problems with the staff client consuming ridiculous amounts of memory. Apparently the situation occurred in previous versions of Evergreen, but to a much less significant extent.