using madcap flare with source control · 2016. 6. 15. · • git • perforce flare’s ui adapts...
TRANSCRIPT
![Page 1: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/1.jpg)
PRESENTED BY
Using MadCap Flare with Source Control
Matthew Ellison UA Europe
Copyright © 2016 Matthew Ellison Consulting Ltd
![Page 2: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/2.jpg)
Agenda
• What is Source Control, and what are its key concepts?
• What are the benefits of working with Source Control?
• What Source Control systems are available, and which should I choose?
• What is the flow of information between MadCap Flare and Source Control?
• How do I use Source Control from within Flare? • How do I tag a version of my project?
![Page 3: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/3.jpg)
Source Control in a nutshell
• A central repository containing a copy of your project, with all previous versions of all project files
• File are copied from source control to a local Workspace for working on
• All changes are copied back from the local Workspace to source control
![Page 4: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/4.jpg)
Source Control Map
*
Server on LAN
PC 1
PC 3
PC 2
PC 4
Workspace
*
*
*
![Page 5: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/5.jpg)
Key benefits of Source Control
• Provides a back-up of your work • Provides a full audit trail • Enables you to takes snapshots of your project
from key dates in the past • Enables team members to collaborate on single
project
![Page 6: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/6.jpg)
Alternatives to Source Control
• Take regular back-ups (Zip Project)
• Modular approach – Each team member works on own project – Projects can be merged during build or at runtime
• Careful team planning and organization
– Each team member works on shared project in turn (never simultaneously)
![Page 7: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/7.jpg)
Survey of Source Control Systems
• Microsoft Team Foundation Server (TFS) • Subversion (SVN) • Git • Perforce
Flare’s UI adapts to the Source Control System that you are using
![Page 8: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/8.jpg)
Bind project to Source Control
Team Member A
Source Control Repository
![Page 9: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/9.jpg)
Bind while creating new project
![Page 10: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/10.jpg)
Bind existing project to Source Control
![Page 11: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/11.jpg)
Pick Source Control Provider
![Page 12: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/12.jpg)
For Subversion: enter server details
![Page 13: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/13.jpg)
Select Project Path
![Page 14: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/14.jpg)
Import Project
Team Member A
Team Member B Source Control
Repository
![Page 15: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/15.jpg)
Import Project
![Page 16: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/16.jpg)
Import Project
![Page 17: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/17.jpg)
Import Project
![Page 18: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/18.jpg)
Import Project
![Page 19: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/19.jpg)
Check Out
Team Member A
Team Member B
![Page 20: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/20.jpg)
Check Out options in Flare
• Allow Flare to check out automatically on Save
• Check out file(s) manually before making changes (not available for SVN or Git)
![Page 21: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/21.jpg)
Check Out on Save
![Page 22: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/22.jpg)
Check Out on Save
![Page 23: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/23.jpg)
Manual Check Out
• Select file(s) that you wish to check out
Content Explorer (dual pane view)
File List
![Page 24: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/24.jpg)
Check In (Commit)
Team Member A
Team Member B
* *
![Page 25: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/25.jpg)
Check In (Commit) options in Flare
• Commit All
• Commit selected files
Pending Changes window
![Page 26: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/26.jpg)
Commit dialog Enter
meaningful comment for
audit trail
![Page 27: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/27.jpg)
Revert file(s)
• Undoes checkout
• Restores file from last committed version in source control
• This is a way to cancel saved changes
![Page 28: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/28.jpg)
Revert file(s)
![Page 29: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/29.jpg)
Get Latest Files
Team Member A
Team Member B
* *
* *
![Page 30: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/30.jpg)
Options for Get Latest File
• On opening project
• Manually for all files or specific files
• Automatically on building Target (no conflict resolution)
Target Editor > General
![Page 31: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/31.jpg)
Resolve conflicts
![Page 32: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/32.jpg)
Merge Changes
Click icon to Keep Change /
Cancel
![Page 33: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/33.jpg)
Viewing History
![Page 34: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/34.jpg)
Viewing History
Roll back to selected version
Compare current version with selected
version
![Page 35: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/35.jpg)
Using the Pending Changes Window
View files checked out
by other users
View locked files (not
checked out)
![Page 36: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/36.jpg)
To Lock… or not?
• Locking prevents other authors from checking in files
• Some source control systems enable you to lock as you check out
• You can choose to do this by default • Locking avoids conflicts • Some source control systems enable you to
steal the lock • Checking in (committing) a file unlocks it by
default
![Page 37: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/37.jpg)
To Lock… or not?
• Some source control systems support Locking • Locking a file prevents other authors from
checking it in, and avoids conflicts • You can choose to lock files by default for
automatic checkouts
• Checking in (committing) a file unlocks it by default
![Page 38: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/38.jpg)
Lock dialog
Some source control systems
enable you to steal the lock from other
authors
![Page 39: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/39.jpg)
Distributed only (Git)
• Files are committed to local repository
• Optional: Coordinate with other authors by Pushing and Pulling from a Remote Database
![Page 40: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/40.jpg)
Distributed only (Git)
Working Copy
Local Repository
Remote Hub Repository
Working Copy
Local Repository
Working Copy
Local Repository
![Page 41: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/41.jpg)
Tagging and Branching
• Tagging is a way of capturing a snapshot of your entire project
• Branching is similar – usually used to add new or trial features that you don’t yet want to incorporate in your main project
• Tagging and branching operations take place outside of the Flare UI in your source control client
![Page 42: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/42.jpg)
Tagging workflow
1. Tag project folder using source control client This creates a new tagged copy in source control
2. In Flare, continue to update project that is bound to main trunk in source control
3. When/if required, create new Flare project by importing project from tagged copy in source control
![Page 43: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/43.jpg)
1. Tag using Tortoise SVN
![Page 44: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/44.jpg)
1. Tag using Tortoise SVN
![Page 45: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/45.jpg)
3. Import tagged copy
![Page 46: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/46.jpg)
3. Import tagged copy
![Page 47: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/47.jpg)
Summary
• Source control adds a range of benefits, particularly in team-based authoring environments
• Flare integrates with and adapts to a range of leading source control applications
• Some source control tasks (branching and tagging) must be done outside of the Flare UI
![Page 48: Using MadCap Flare with Source Control · 2016. 6. 15. · • Git • Perforce Flare’s UI adapts to the Source Control System that you are using . Bind project to Source Control](https://reader036.vdocument.in/reader036/viewer/2022071110/5fe5e7dbc11b56055a247380/html5/thumbnails/48.jpg)
PRESENTED BY
Thanks for attending! Final questions?
Matthew Ellison [email protected]
Copyright © 2016 Matthew Ellison Consulting Ltd