Difference between revisions of "Developer Info"
m (→Old information)
m (→Making a Release)
|Line 45:||Line 45:|
===Making a Release ===
===Making a Release ===
* [] A general template for making a release. This references some of the pages below.
== Software process issues: ==
== Software process issues: ==
Revision as of 19:17, 1 July 2019
- OPeNDAP's GitHub repositories: OPeNDAP's software is available using GitHub in addition to the doenloads from our website.
- Before 2015 we hosted our own SVN repository. It's still online and available, but for read-only access, at https://scm.opendap.org/svn.
- Continuous Integration builds: Software that is built whenever new changes are pushed to the master branch. These builds are done on the Travis-CI system.
- test.opendap.org: Test servers with data files.
- We use the Coverity static system to look for common software defects, information on Hyrax is spread across three projects:
- 1 OPeNDAP's FAQ
- 2 OPeNDAP Workshops
- 3 libdap4 and BES Reference documentation
- 4 BES Development Information
- 5 OPeNDAP Development process information
- 6 Software process issues:
- 7 General development information
- 8 Old information
1 OPeNDAP's FAQ
The OPeNDAP FAQ has a pretty good section on developer's questions.
2 OPeNDAP Workshops
- The APAC/BOM Workshops: This workshop spanned several days and covered a number of topics, including information for SAs and Developers. Oct 2007.
- ESIP Federation Server Workshop: This half-day workshop focused on server installation and configuration. Summer 2008
- Server Functions: This one-day workshop is all about writing and debugging server-side functions. It also contains a wealth of information about Hyrax, the BES and debugging tricks for the server. Spring 2012. Updated Fall 2014 for presentation to Ocean Networks Canada.
3 libdap4 and BES Reference documentation
4 BES Development Information
- How to debug the BES
- BES - Debugging Using besstandalone
- How to create your own BES Module
- Hyrax Module Integration: How to configure your module so it's easy to add to Hyrax instances (pdf)
- Starting and stopping the BES
- Running the BES command line client
- BES Client commands. The page BES XML Commands repeats this info for a bit more information on the return values. Most of the commands don't return anything unless they return an error and are expected to be used in a group where a get command closes out the request and obviously does return a response of some kind (maybe an error).
- BES Administrative Commands
- Extending your BES Module
- Example BES Modules - the Hello World example and the CSV data handler
- BES communication protocol using PPT (point to point transport)
5 OPeNDAP Development process information
These pages contain information about how we'd like people working with us to use our various on-line tools.
- Hyrax GitHub Source Build This explains how to clone our software from GitHub and build our code using a shell like bash. It also explains how to build the BES and all of the Hyrax 'standard' handlers in one operation, as well as how to build just the parts you need without cloning the whole set of repos. Some experience with 'git submodule' will make this easier, although the page explains everything.
- Bug Prioritization. How we prioritize bugs in our software.
5.1 Making a Release
- How to Make a Release A general template for making a release. This references some of the pages below.
6 Software process issues:
- How to configure a CentOS machine for production of RPM binaries - Updated 12/2014 to include information regarding git.
- How to use Eclipse with Hyrax Source Code Assuming you have cloned our Hyrax code from GitHub, this explains how to setup eclipse so you can work fairly easily and switch back and forth between the shell, emacs and eclipse.
- How to add timing instrumentation to your BES code.
- How to write unit tests using CppUnit
- How to use valgrind with unit tests
- Debugging the distcheck target Yes, this gets its own page...
- How to copyright software written for OPeNDAP
- Managing public and private keys using gpg
- How to Setup Secure Email and Sign Software Distributions
- How to Handle Email-list Support Questions
- Security Policy and Related Procedures
- Software version numbers
- Development Guidelines
6.1 AWS Tips
7 General development information
These pages contain general information relevant to anyone working with our software:
- Git Hacks and Tricks: Information about using git and/or GitHub that seems useful and maybe not all that obvious.
- Valgrind Suppression File Howto How to build a suppressions file for valgrind.
- Using a debugger for C++ with Eclipse on OS/X Short version: use lldbmi2 **Add info**
- Using ASAN Short version, look at the Google/GitHub pages for useful environment variables **add text** On Centos, use yum install llvm to get the 'symbolizer' and try ASAN_OPTIONS=symbolize=1 ASAN_SYMBOLIZER_PATH=$(shell which llvm-symbolizer)
- How to use ''Instruments'' on OS/X to profile Updated 7/2018
- Valgrind - How to generate suppression files for valgrind This will quiet valgrind, keeping it from telling you OS/X or Linux (or the BES) is leaking memory.
- Migrating source code from SVN to git: How to move a large project from SVN to git and keep the history, commits, branches and tags.
- Eclipse - Detailed information about running Eclipse on OSX from the Mozzilla project. Updated in 2017, this is really good but be aware that it's specific to Mozilla so some of the tips don't apply. Hyrax (i.e., libdap4 and BES) also use their own build system (autotools + make) so most of the configuration information here is very apropos. See also How to use Eclipse with Hyrax Source Code below.
- RPM Guide The best one I'm found so far...
- Autotools Myth busters The best info on autotools I've found yet (covers autoconf, automake, libtool and pkg-config).
- The autoconf manual
- The automake manual
- The libtool manual
- A good gdb to lldb cheat sheet for those of us who know gdb but not lldb.
8 Old information
Note: Old build information
8.1 The Release Process
- Make sure the hyrax-dependencies project is up to date and tar balls on www.o.o. If there have been changes/updates:
- Update version number for the hyrax-dependencies in the Makefile
- Save, commit, (merge?), and push the changes to the master branch.
- Once the hyrax-dependencies CI build is finished, trigger CI builds for both libdap4 and bes by pushing change(s) to the master branch of each.
- Making a source release of libdap
- Making a source release of the BES.
- Make the OLFS release WAR file. Follow these steps to create the three .jar files needed for the OLFS release. Includes information on how to build the OLFS and how to run the tests.
- Make the official Hyrax Docker image for the release When the RPMs and the WAR file(s) are built and pushed to their respective download locations, make the Docker image of the release.
8.2 Supplemental release guides
Old - use the packages built using the Continuous Delivery process
- Make the RPM Distributions. Follow these steps to create an RPM distribution of the software. Note: Now we use packages built using CI/CD, so this checklist is no longer needed.
Note: The following is all about using Subversion and is out of date as of November 2014 when we switched to git. There are still good ideas here...
- How to merge code
- Using the SVN trunk, branches and tags to manage releases.
- Making a Branch of Shrew for a Server Release. Releases should be made from the trunk and moved to a branch once they are 'ready' so that development can continue on the trunk and so that we can easily go back to the software that mad up a release, fix bugs, and (re)release those fixes. In general, it's better to fix things like build issues, etc., discovered in the released software on the trunk and merge those down to the release branch to maintain consistency, re-release, etc. This also means that virtually all new feature development should take place on special feature branches, not the trunk.
- Hyrax Package for OS-X. This describes how to make a new OS/X 'metapackage' for Hyrax.
- Making Windows XP distributions. Follow these directions to make Windows XP binaries.
- Making a Matlab Ocean Toolbox Release. Follow these steps when a new Matlab GUI version is ready to be released.
- Eclipse - How to Setup Eclipse in a Shrew Checkout This includes some build instructions
- How to configure a Linux machine to build Hyrax from SVN
- How to configure a SUSE machine for production of RPM binaries
- How to configure an Amazon Linux AMI for EC2 Instance To Build Hyrax
- Notes from setting up Hyrax on our new web host
- Subversion 1.7 documentation -- The official Subversion documentation; PDF and HTML.
- OPeNDAP's Use of Trac -- How to use Trac's various features in the software development process.