Changes between Version 14 and Version 15 of DeveloperGuidelines/Git/GCI

Timestamp:

12/06/14 04:56:09 (11 years ago)

Author:

Pat Tressel

Comment:

--

DeveloperGuidelines/Git/GCI

@@ -94 +94 @@
 === Aggregation cycle ===
 
-This is where it gets interesting...
+This is where it gets interesting... Here are the steps to prepare student work for a PR to the main repository,
+and to switch to fresh base and staging branches for additional student work.
+
+* Make sure there are no branches called base_done and staging_done in the edengci repository. That would mean the
+  previous aggregation cycle is incomplete, or the branches were not cleaned up. Talk to the other mentors to find
+  out what happened. When that's resolved...
+* If there are any open student PRs:
+ * Post a note to the student GCI announcements thread in the sahana-eden mailing list asking students to pause in
+   sending PRs until you say it's ok. (We'll add a link here to the announcements thread when it's ready.)
+ * Open the web page for each PR, as you'll need to post comments there after they are closed.
+ * Post a comment in each open PR, telling the student that you're starting an aggregation cycle, and are going
+   to temporarily close their PR. They should watch for another comment or post in the announcements thread, and
+   then open their PR again on the (new) staging branch, and rebase it from staging.
+ * Close the open PRs.
+ * Make one last check for open PRs in case any snuck in...
+
+* Rename the base and staging branches on !GitHub, as follows:
+ * If you have local branches called base or staging, rename or delete them, e.g.:
+{{{
+git branch -m staging staging_old
+git branch -m base base_old
+}}}
+ * Pull copies of base and staging from the edengci repository.
+{{{
+git pull edengci staging
+git pull ededgci base
+}}}
+ * Rename them.
+{{{
+git branch -m staging staging_done
+git branch -m base base_done
+}}}
+ * Push to their new names.
+{{{
+git push edengci staging_done
+git push edengci base_done
+}}}
+
+* Make fresh base and staging branches. (The commands show assume that "upstream" is the name of the remote
+  you use for the main repository. If not, use whatever your remote name is.)
+{{{
+git pull upstream master:base
+git push edengci base
+git push edengci base:staging
+}}}
+
+* At this point, the new staging branch is ready for business. Post on the GCI announcement thread that
+  students can re-open any PRs that had to be closed to rename staging, and can add new PRs.
+
+* Post a comment in each closed PR telling the student they should now rebase their work from the (new)
+  staging branch, fix any conflicts, and do another PR.
+
+* Next, prepare for the PR to the main repository. Check out staging_done.
+{{{
+git checkout staging_done
+}}}
+
+* Run the test suite on your local copy of staging_done. If all has gone well with individual code reviews,
+  there should be no problem here. But if there is, work with the student whose commit has the problem to
+  resolve it. The student may need to do a PR to staging_done. Or you may want to fix the issue if it is
+  minor and not due to a problem with the student's work. Don't bother with attempting to squash commits
+  here, as we want to retain the student names as authors of the their commits.
+
+* Run Eden from the staging_done branch. Go through the students' PR pages, and look for their comment
+  about how to observe their change. Do that, and check that it still works. Again, if there's a problem,
+  work with the student to fix it.
+
+* If there were any fixups needed, push them to the staging_done branch.
+
+* Do a PR to the main repository. Add a comment with the PR that tells what is in it -- should be able to
+  scrape these from the students' PRs. As a courtesy, also scrape the student's instructions for testing --
+  Mark this so it's easily distinguished from the descriptive comment.
 == Student Workflow ==