Release Procedure
The tracked GitHub repository for the ExoMy docu shall contain the source files (SolidWorks, Fritzing, Code, etc.). All exported file formats (STL, STEP, PNG, PDF, etc.) shall be packaged into a zip file, that is attached to a release. This helps to reduce the total file size of the repository.
Downloading the exported part should be enough to build ExoMy with the instructions from the wiki. The files from the repository should be downloaded if one wants to modify ExoMy
Semantic versioning is used in the ExoMy release numbering. vMAJOR.MINOR.PATCH for example v1.0.1 with the following criteria deciding which number should be increased between releases.
Major: Interface changes between assemblies and parts.
Minor: New features added to the core assembly.
Patch: Small improvements in the design and the addition of optional parts to the project.
For releases, which only introduce optional parts and make small changes (hole dimensions, added fillet/chamfer) to the core the simplified patch release proceedure can be applied.
Once the drawings and the number of parts in the core assembly are changed the full release proceedure has to be followed.
The software is organized in the separate repository https://github.com/esa-prl/ExoMy_Software.
The .fzz file contains everything you need to open the project again. It is an archive file that can be opened with a standard archive manager like 7-Zip. To create the exported files:
- Go to Breadboard view
- File -> Export -> as Image
- Store as
.svg,.pdfand.jpg
- Do the same for the Schematic view
The export, modification and updating of all files is drastically simplified with the use of #TASK. Update 05-2020: The free version was removed so a license has to purchased or an alternative has to be found.
- Make sure all parts are in the assembly. This includes cables, screws, zip ties, glue, etc. The bill of materials are generated from the drawings so only if it is Solidworks, will it be ordered.
- Copy Template ExoMy Release v0.0.0 and rename to remove Template and set the release number.
It is important that the tasks will be run on all configurations. Active the option in the bottom right corner of the task window as shown here:
Enable Feature freezing in Solidworks.
Freeze all parts using #TASK.
Items Scope: ExoMy/Mechanical Design
Tasks: Freeze Feature Tree
- Naming of files should be for assemblies & parts and
[$title]for drawings.
Options applying for all parts exports.
Output File Name: [title]\_[$conf]
Drag and drop all 3D print parts (not assemblies) into the item scope.
Items Scope: ExoMy/Mechanical Design/P*_FILENAME.SLDPRT
Task: Export
Destination Folder: ExoMy/ExoMy Release vx.x.x/Parts/STL
Manually export the *.STL files of the bodies by selecting all bodies that should be printed in a color and saving them as an *.STL with option "save only selected bodies". Then do the same for the bodies of the second color.
Name them as follows:
FILNAME_INKL_CONFIGURATION_1.SLDPRT
FILNAME_INKL_CONFIGURATION_2.SLDPRT
Delete the batch exported two color print *.STL to avoid confusion.
Go to Options > Export > File Format: > TIF/PSD/JPG/PNG
Set Output as = Print capture
Set DPI: 100
Paper Size: Custom (200 mm x 200 mm)
Items Scope: ExoMy/Mechanical Design
Task: Publish Images
Publish Options: Zoom To Fit, Isometric, (Photo Realistic Images (Did not work for me...))
Watermark Location: Bottom Right
Watermark Image: /ExoMy.wiki/images/release_instructions/esa_logo_black.bmp
Output Folder: ExoMy/ExoMy Release vx.x.x/Parts/JPEG
Lets export a *.STEP file for all 3D printed parts and one for the main assembly.
Items Scope: ExoMy/Mechanical Design/P*_FILENAME.SLDPRT
ExoMy/Mechanical Design/A01_ExoMy.ALDASM
Task: Export
Destination Folder: ExoMy/ExoMy Release vx.x.x/Parts/STEP
Options applying for all drawing exports.
Items Scope: ExoMy/Mechanical Design/Drawings
Output File Name: [$title]
Then go through the drawings and make sure the balloons and tables are correctly set. Changes in components usually require manual adjustment in the drawings. Especially, in the AI_Integration_BoM.SLDDRW, as a lot of components are hidden in the BoM
Task: Update And Save
Options: Rebuild, Zoom To Fit
Tasks: Save PDF
Destination Folder: ExoMy/ExoMy Release vx.x.x/Drawings/PDF
Options: Save Only Current Sheet
Go to Options > Export > File Format: > TIF/PSD/JPG/PNG
Set Output as = Print capture
Set DPI: 100
Paper Size: A3 Landscape
Task: Export
Destination Folder: ExoMy/ExoMy Release vx.x.x/Drawings/JPEG
Extension: JPEG
Task: Export Table
Destination Folder: ExoMy/ExoMy Release vx.x.x/Drawings/CSV
Output Format: csv
Match Pattern: *
Open ExoMy/ExoMy Release vx.x.x/Drawings/CSV/PI_ExoMy_All_Parts_BoM.csv in Excel
Save in ExoMy/ExoMy Release vx.x.x/BoM/PI_ExoMy_Purchasing_BoM.xlsx
Add filtering, and hide all P*_ parts. Now, only the purchased parts are visible.
Compare the BoM to the one from the previous release and copy paste the correct columns, etc.
Export as PDF into the same folder.
Open ExoMy/ExoMy Release vx.x.x/Drawings/CSV/MI_Printed_Parts_BoM.csv in Excel
Save in ExoMy/ExoMy Release vx.x.x/BoM/MI_Print_Settings.xlsx
Compare the BoM to the one from the previous release and copy paste the correct columns, etc.
There might be an easier way to do this...
Export as PDF into the same folder.
The SimLab SolidWorks Plugin was used to export the *.glb file that is used on the website. Starting from SolidWorks 2019 this export feature should be already included.
- Duplicate the last release folder.
- Bump the new folders patch release number ExoMy Release vx.x.PATCH.
- Instead of exporting all parts, export only the changed parts following the same naming conventions as above. This should only be (STL, STEP and PNG) but no drawings.
- Follow the sae proceedure about updating the wiki as described bellow.
Copy the BoM, Technical- & Electrical_Drawings folders into a new folder with the version number of the release. Do not copy the Parts directory as it is too large.
Put new instructions where needed (assembly instructions drawings downloads for example.)
Change version number of which wiki is supporting which release.
Add the new additions and fixes to the CHANGELOG.md and update the release number and date therein. Push your changes to GitHub.
After preparing the release folder it is time to upload it to GitHub.
-
Zip your release folder which is named something like: ExoMy Release v1.0.0.
-
Create a new release here.
-
Find a descriptive name for the release.
-
Copy and paste the release description from the previous release. Replace the release notes with the ones from the
CHANGELOG.md. -
Upload zip file.
-
RELEASE! :)