ITK Release 4/Users Migration Guide/Developer Migration Guide Workflow

From KitwarePublic
Jump to navigationJump to search

File:MigrationGuideWorkFlow.pdf

Error creating thumbnail: Unable to save thumbnail to destination
Initial Setup
  • Published migration guide pulled directly from master XML files
  • Sequestered applications compiling correctly
Error creating thumbnail: Unable to save thumbnail to destination
Topic Branch
  • Standard git workflow
Error creating thumbnail: Unable to save thumbnail to destination
Local Changes
  • Standard git workflow
Error creating thumbnail: Unable to save thumbnail to destination
Migration Guide XML
  • Before pushing topic to Gerrit, must create a unique XML document that documents changes to API
  • XML documents will live in the source tree in a new directory
Error creating thumbnail: Unable to save thumbnail to destination
Gerrit Review
  • Standard Gerrit review process
  • Make any necessary changes
Error creating thumbnail: Unable to save thumbnail to destination
Finalize Migration Guide XML
  • Before review can be completed, the XML file must be revised to accurately reflect API changes
Error creating thumbnail: Unable to save thumbnail to destination
Merge to master
  • Merge the topic branch to master in the normal manner using stage
  • Once change is merged into master, the published migration guide will automatically update
  • Wait for nightly Sequestered Applications builds
Error creating thumbnail: Unable to save thumbnail to destination
Applications Fail
Error creating thumbnail: Unable to save thumbnail to destination
Create Applications Topic Branch
  • Checkout current version of sequestered applications
Error creating thumbnail: Unable to save thumbnail to destination
Fix Broken Applications
  • Make necessary changes to fix compilation errors for the applications
Error creating thumbnail: Unable to save thumbnail to destination
Add Migration Guide Links
  • When committing changes to sequestered applications, developer will be asked for ID of Migration Guide Page
  • Changes will be automatically linked to published migration guide page