SCM version control, auditing, and reporting (Page 2)

Search DominoPower's 11,441 Lotus-related article archive

Home
EasyPrint
News details

Articles-only

Twitter Feed

SCM version control, auditing, and reporting (continued)

FIGURE A

Here's an example of branching in a software development project. Roll over picture for a larger image.

Basic concepts of SCM version control
Version control systems track various versions of a set of files and store the various versions of files in a database. During the versioning process, developers interact with each other in different ways.

There is a general sequence of events (operations) that takes place when using version control systems. Table A illustrates this.

Order	Operation	Description
1	Connect	A database must be set up on a local file system or on a TCP file server.
2	Add	Add new and existing files to the database.
3	Checkout	Once files are in the database, modify them and submit changes.
4	Undo Checkout	If you change your mind, revert to the last state of the file.
5	Check in	Once you have made and tested your changes, put them back in the database for storage and for others to view, and describe what changes were made.
6	Label	After all changes have been made, label all file versions for future reference.
7	Get	You may need to go back and look at older versions of files, or get the latest versions of all files after others have made changes.
8	Rename or Delete	After a while, files may become obsolete or need renaming.
9	Difference, History, Properties, and Status	Version control systems can generate various useful reports about files.

SCM Audit and Report Process
The SCM audit and report process involves completing a series of steps to provide repeatable SCM processes and application baseline integrity. There are generally five steps to the SCM audit and report process performed by the Project Manager, SCM Manager, Audit Team, and Recorder.

Step 1: Determine what to audit and when to perform the audit
The Project Manager or SCM Manager begins the audit and report process by considering audit questions, using checklists for consistency, and determining a specific audit date. When all of this is done, you will have provided a set of audit questions and scheduled your audit.

Step 2: Select the Audit Team
The Project Manager or SCM Manager has the additional responsibilities of selecting an SCM Engineer, Developer, and Recorder for the audit. Here, you will also assign roles to each member (who will audit what).

Step 3: Prepare for the audit
The Audit Team must schedule meetings prior to the audit with the Project Manager and Application Owner.

Step 4: Perform the audit
The Audit Team also has the task of actually performing the audit. During this phase, the Audit Team discusses audit questions with project personnel and documents the results. The Team completes the audit by determining whether areas pass or fail, and recommends action if needed.

Step 5: Report results
The Recorder documents status including what's been done well, and identifies areas needing improvement, indicating recommended actions. The Recorder then reports the results to the Project Manager, SCM Manager, and Application Owner. Next, the Recorder opens Problem Reports for Audit Improvement and tracks them until closed. The final task is to place a copy of the audit results into the application repository, which produces the SCM Audit Report with Opportunities for Improvement.

Conclusion
There are many practical reasons to use SCM version control. Even small projects requiring only one developer should use version control. By using SCM version control, developers can prevent the risk of damaging each other's work, leading to version confusion. Version control is essential for software development and is extremely useful for managing Web sites and other documentation that must be controlled and archived.

There's more to come about SCM. Stay tuned for an overview and comparison of enterprise SCM tools.

Dan Velasco is a Senior Technical Editor for WebSpherePower Magazine and DominoPower Magazine. He's a Sun Certified Java Programmer, Sun Certified Web Component Developer and an IBM Certified Solution Developer for WebSphere Studio V5.0. He's also a Principal CLP Application Developer (R4, R5 and ND6) as well as a CLP System Administrator (R4 and R5). You can reach him via email at dvelasco@webspherepower.com or on the Web at http://DanVelasco.com.