Changes between Version 86 and Version 87 of ReleasePractices/ManagerCheckList


Ignore:
Timestamp:
Jan 22, 2015, 2:40:50 PM (8 years ago)
Author:
Beman Dawes
Comment:

Update New lib checklist for Git

Legend:

Unmodified
Added
Removed
Modified
  • ReleasePractices/ManagerCheckList

    v86 v87  
    11[[PageOutline]]
    22
    3 = Release Manager's Checklist =
     3= Release Manager Checklists =
    44
    55== Introduction ==
     
    5757== New Library Checklist ==
    5858
    59 Before a new library is merged into branches/release, the release manager should verify:
     59=== Create !GitHub Repository
     60
     61Before a release manager creates a [https://github.com/boostorg boostorg GitHub] repository for the new library, the release manager should send an email to
     62developer:
     63
     64    * Ask the developer to read this checklist (i.e. https://svn.boost.org/trac/boost/wiki/ReleasePractices/ManagerCheckList#NewLibraryChecklist) so that he or she will be aware of the steps that will have to be completed to add a library to the Boost distributions.
     65    * Ask for the GitHub user-id of the developer and anyone else to be given read-write access to the library's repository.
     66
     67The release manager performs two steps to add the new library to [https://github.com/boostorg GitHub]:
     68
     69    * [https://github.com/orgs/boostorg/new-team Create the library's repository]. Note: the release manager creates a repo that is empty except for a readme file. The library's developer is responsible for creating the library's contents.
     70    * [https://github.com/orgs/boostorg/new-team Create a team for the library].
     71
     72=== Add library as a submodule on boost develop branch ===
     73
     74Before a release manager adds the library as a submodule on the boost super-project develop branch, the release manager should verify the library is ready to start regression testing:
     75
     76    * The critical elements of the library xxx directory structure are in place:
     77        * libs/xxx/include/boost/xxx has the header files.
     78        * libs/xxx/test has a Jamfile.v2, and {{{b2}}} works. Tests don't have to pass, but the Jamfile needs to be in good enough shape that it will not break regression testing.
     79        * If it is a compiled library, libs/xxx/build has a Jamfile.v2 in in good enough shape that it will not break regression testing.
     80        * The directory structure in general is reasonably complete and boost-like.
     81    * Run inspect and verify the report is not a total disaster. It does not have to be totally clean, but it should be clean enough to indicate the developer has the general idea of what is required.
     82
     83=== Add library as a submodule on boost master branch ===
     84
     85Before a release manager adds the library as a submodule on the boost super-project master branch, the release manager should verify:
    6086
    6187    * root/libs/libraries.htm entry is OK, both in the alphabetic list and in the category lists.
     
    6389    * The library's root/libs/xxx directory contains an index.html file with either the main docs or a redirection to the main docs.
    6490    * The primary docs pages meet Boost requirements and guidelines. Don't leave this until too late; it has turned up lots of issues in the past.
    65     * Trunk inspection report is clean.
    66     * Trunk regression tests are reasonably clean or marked up.
    67 
    68 After a new library is merged into branches/release, the release manager should verify:
     91    * Inspection report is clean.
     92    * Regression on develop tests are reasonably clean.
     93
     94After a new library is merged into master, the release manager should verify:
    6995
    7096    * Doc builds, if any, are running properly.