Finalizing Release Package
- Kyle Wilson (Deactivated)
This is a guide for finalizing a development build for release. This process should be completed after all defects and features have been tested by QA and received release notes.
Release Notes
Shared location for Release Notes:
The release notes for each product can be found on the SharePoint site above. Each defect or feature that passes testing receives a release note in the respective document. Once a release is ready to be distributed to customers, the release notes must be reviewed for grammar and formatting.
Sample Formatting Guide:
Items to Check
Spelling
Grammar
Screenshots
Duplicate Tickets
Tickets in numerical order
Defects and Features in correct place
Heading formatting
Matching note formats
Version Number Headers
Product information
Trademark year (page 2)
Footer
Once everything on the document has been reviewed, add a new line to the revision history stating that you finalized the release:
Save to the Download Package
Once the notes are finalized, they have to be saved to the download package. This is the location that the development builds are placed after the build packager runs.
\\ptg-server1\Software\Downloads\Product
There should already be a Documentation folder in the package, but if there isn’t, create one.
Once save to this location, the file will be in Word format. Export it to PDF format and then deleted the Word version.
The Update/Install guide should also be saved to this location as a PDF. If it does not already exist, check the Documentation SharePoint (not the same as the Release Notes SharePoint).
Zip the Package and Update the Download Location
Once the documentation has been saved to the download package, the files must all be zipped up. Then the zip package should be placed in the correct folder on the external share location:
\\10.222.40.10\Downloads
A download link can be created by completing the following:
https://downloads.ptghome.com/Downloads/
Example: https://downloads.ptghome.com/Downloads/Benchmark/Client/BenchmarkRelease_v2.9.43.0.zip
Tech Bulletins and Release Approvals
Start a new word document with the Tech Bulletin format document:
Save this document with the Date and Release Product as the name:
Examples:
Share the bulletin document and the Sign-Off document with the Stakeholders for approval. Sign Off documents can be found here:
Once approved, the tech bulletin draft can be copied into an email. BCC all internal stakeholders and the external target recipients.