Skip to content

Commit f6e01d2

Browse files
Starting from RussellManser-NCO:feature/branch_standards; streamlined and added links
1 parent d0e8f07 commit f6e01d2

1 file changed

Lines changed: 28 additions & 6 deletions

File tree

docs/standards.rst

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -661,11 +661,33 @@ Example call:
661661
Code Delivery and Vertical Structure
662662
====================================
663663

664-
All components of an application to be run in the NCO production environment must be delivered to IDSB's Senior Production Analysts (SPA) via subversion, git or any other version control system that WCOSS has access to.
665-
When modifying an application that is already in production, always begin with the most recent production version at ``https://svnwcoss.ncep.noaa.gov/MODEL/tags/``.
664+
A. Code Delivery
665+
----------------
666+
The following requirements apply to production code deliveries to NCO:
666667

668+
.. _req-release-branch-name:
667669

668-
A. Source Code Compilation (C or Fortran)
670+
* Code must exist on a release branch.
671+
672+
* Release branch names will follow the naming convention: ``release/vX.Y.Z``
673+
674+
.. _req-release-tag-name:
675+
676+
* The release branch must have a corresponding release tag.
677+
678+
* Release tags will follow the naming convention: ``<model_name>.vX.Y.Z``
679+
680+
.. _req-release-obtain:
681+
682+
* NCO SPA team members must be able to acquire your code with the following git commands:
683+
684+
``$ git clone git@github.com:<organization>/<model_name>.git <model>.vX.Y.Z``
685+
686+
``$ cd <model_name>.vX.Y.Z``
687+
688+
``$ git checkout tags/<model_name>.vX.Y.Z -b release/v.X.Y.Z``
689+
690+
B. Source Code Compilation (C or Fortran)
669691
-----------------------------------------
670692

671693
The directory structure, compilation scripts, makefiles, and documentation for building must be understandable to someone unfamiliar with the specifics of your model.
@@ -695,7 +717,7 @@ Do not deliver pre-built executables or libraries to IDSB. It is the SPA's respo
695717
* Clear, concise instructions (see Example 10 in `Appendix A: Workflow Examples`_) will reduce confusion and errors if it becomes necessary to rebuild the executable quickly.
696718

697719

698-
B. Directory Structures
720+
C. Directory Structures
699721
-----------------------
700722

701723
All components of an application to be implemented into the production environment are required to be in vertical structure, where, with the exception of system or standard production libraries and input data, all of the files required to completely build and run the jobs are contained in an application-specific package.
@@ -776,7 +798,7 @@ Table 5 (below), Table 7, Table 8, and Table 9 (in `Appendix B: Variables and Di
776798

777799

778800

779-
C. Unresolved Bugs
801+
D. Unresolved Bugs
780802
------------------
781803

782804
Before handing off code to NCO, all Bugzilla entries must be addressed.
@@ -1211,4 +1233,4 @@ Appendix B: Variables and Directory Structure Tables
12111233
"``$DCOMROOT/YYYYMMDD/bTTT/xxSSS``","BUFR data tanks"
12121234

12131235

1214-
*TTT* and *SSS* correspond to the 3-digit BUFR data category type and sub-type, respectively
1236+
*TTT* and *SSS* correspond to the 3-digit BUFR data category type and sub-type, respectively

0 commit comments

Comments
 (0)