incubator-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From johndam...@apache.org
Subject svn commit: r1601801 - /incubator/public/trunk/report_runbook.py
Date Wed, 11 Jun 2014 02:47:26 GMT
Author: johndament
Date: Wed Jun 11 02:47:26 2014
New Revision: 1601801

URL: http://svn.apache.org/r1601801
Log:
Added heading information based on report manager template email.

Modified:
    incubator/public/trunk/report_runbook.py

Modified: incubator/public/trunk/report_runbook.py
URL: http://svn.apache.org/viewvc/incubator/public/trunk/report_runbook.py?rev=1601801&r1=1601800&r2=1601801&view=diff
==============================================================================
--- incubator/public/trunk/report_runbook.py (original)
+++ incubator/public/trunk/report_runbook.py Wed Jun 11 02:47:26 2014
@@ -25,10 +25,23 @@ import datetime
 
 from report_timeline import Timeline
 
+def header(options):
+    return strip_indent("""
+        ##################################################################
+        # This doc is meant to be a guide to preparing the incubator
+        # report for a given month.  Each section has a heading, starting
+        # with mechanical, editorial, or Chair.  If you have volunteered
+        # to perform any of these actions, please pay attention to
+        # those sections.
+        ##################################################################
+    """)
+
 def timeline_email(options):
     timeline = Timeline(month=options['month']).to_email()
     return strip_indent("""
         ##################################################################
+        # mechanical -- Send report timeline email.
+        #
         # On the last Wednesday of the month, send an email to
         # general@incubator announcing the report timeline, using the
         # following content.
@@ -43,10 +56,12 @@ def assemble_release_list(options):
     date_spec = "{{{date:%Y}-{date:%m}-{date:%d}}}:HEAD".format(date=date)
     return strip_indent("""
         ##################################################################
+        # editorial  -- Assemble list of releases.
+        #
         # The Board report must contain a list of releases by the
         # Incubator project since the last report.  This can be assembled
         # manually from the history of our dist area.
-        # 
+        #
         # The date of each release is the date it appeared in our dist
         # area.  Since our report periods don't have hard boundaries,
         # the only way to know which reports made the cut last month and
@@ -60,6 +75,8 @@ def assemble_release_list(options):
 def summarize_podling_reports(options):
     return strip_indent("""
         ##################################################################
+        # editorial  -- Create podling summary.
+        #
         # After the podling reporting deadline has passed, group
         # podlings into the following categories (additional categories
         # may be added if appropriate):
@@ -70,17 +87,31 @@ def summarize_podling_reports(options):
         #   * Community growth
         # * Ready to graduate
         # * Did not report, expected next month
+        #
         ##################################################################
 
         # For any podlings that did not report, add a "monthly" attribute
         # in podlings.xml.  See http://s.apache.org/At0 for a sample commit.
+        # mechanical -- Assign podlings which do not report to "monthly".
         [... edit podlings.xml with your editor of choice ...]
         svn ci -m "Assign podlings which did not report to 'monthly'."
+
+        ##################################################################
+        # editorial  -- Write narrative, misc, legal, infrastructure, etc.
+        #    sections.
+        #
+        # After the podlings are compiled, please add the various sections
+        # listed above.  To do this, visit the incubator mail archives for
+        # the preceeding month and review any actions performed.  Were
+        # there any code donations? Podlings renamed?  Unexpected outages?
+        ##################################################################
         """)
 
 def normalize_formatting(options):
     return strip_indent("""
         ##################################################################
+        # mechanical -- Normalize report formatting
+        #
         # Normalize the formatting of the podling reports and shepherd
         # reviews.  Remove any blank entries.
         #
@@ -99,6 +130,8 @@ def normalize_formatting(options):
 def send_draft_to_general(options):
     return strip_indent("""
         ##################################################################
+        # mechanical -- Send "shepherding" email.
+        #
         # Once the deadline has passed for the editorial and shepherding
         # tasks, a draft of the report should be sent to
         # general@incubator for review.
@@ -117,6 +150,8 @@ def send_draft_to_general(options):
 def file_report(options):
     return strip_indent("""
         ##################################################################
+        # Chair      -- Deliver report to Board.
+        #
         # On the day that the report is due to be submitted to the Board,
         # no action by the Report Manager is required.
         #
@@ -129,6 +164,8 @@ def prep_next_wiki_report_template(optio
     next_month = (options['month'] % 12) + 1
     return strip_indent("""
         ##################################################################
+        # mechanical -- Prepare next month's report template.
+        #
         # Prepare next month's wiki report template.
         ##################################################################
 
@@ -176,6 +213,7 @@ def process_cli_args():
 def main():
     options = process_cli_args()
     text = ""
+    text += header(options)
     text += timeline_email(options)
     text += summarize_podling_reports(options)
     text += assemble_release_list(options)



---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@incubator.apache.org
For additional commands, e-mail: cvs-help@incubator.apache.org


Mime
View raw message