Add commit message documentation.

[wizard.git] / TODO

diff --git a/TODO b/TODO
index 24c39f3974faaa0b420905b513f38fa4e6cfa6c1..40ce07e6d92981664d0e56122812cb9a3a79d913 100644 (file)
--- a/TODO
+++ b/TODO
@@ -2,6 +2,18 @@ The Git Autoinstaller
 
 TODO NOW:
 
+- Migration script needs to delete .scripts-version/move
+  it somwhere else, since it's deprecated
+- Migration script needs to make an empty commit with the
+  user's changes that says "Initial migration", and then
+  has wizard info
+- We need to figure out how much info Wizard will barf into
+  the commit message. Candidates:
+    o Wizard revision
+    o Wizard command line args
+    o Person running the command (quentin claims there's an
+      SSH patch that puts the Kerberos principal in REMOTE_USER)
+
 - Check how many autoinstalls are missing w bits for
   daemon.scripts (this would need pyafs)
 - Add repository flag to migrate so that we can specify an
@@ -16,6 +28,14 @@ TODO NOW:
 - Need an upgrade script OR
 - Need survey script
 
+COMMIT MESSAGE FIELDS:
+
+Installed-by: username@hostname     # person who ran autoinstaller
+Updated-by: username@hostname       # person who upgraded an autoinstall
+Migrated-by: username@hostname      # person who migrated an autoinstall
+Wizard-revision: abcdef1234567890   # revision of wizard used
+Wizard-args: wizard foo bar baz     # arguments passed to Wizard
+
 NOTES:
 
 - A perfectly formed autoinstall with upgrade paths for all of