Katenary/katenary
2
0
Fork 3
Code Issues 13 Pull Requests 2 Actions Packages Projects 4 Releases 18 Wiki Activity

Develop #131

Merged
metal3d merged 9 commits from develop into master 2025-07-07 21:02:13 +00:00
Conversation 0 Commits 9 Files Changed 10
+563 -406
metal3d commented 2025-07-07 20:51:58 +00:00
Owner
Copy Link
Copy Source

This pull request introduces several updates to the Makefile for improved build processes, new features, and better organization, alongside documentation improvements. Key changes include adding support for Windows installer generation, refining build modes, reintroducing testing commands, and enhancing documentation for clarity and consistency.

Build Process Enhancements:

  • Added support for generating a Windows installer using NSIS, including downloading and configuring the required EnVar.dll plugin (Makefile, MakefileR160-L166).
  • Introduced a MODE variable to differentiate between default and release build modes, modifying the VERSION string accordingly (Makefile, MakefileR4-R41).
  • Updated the dist target to include signing, compression, and signature verification steps, and removed the deprecated push-release target (Makefile, [1] [2].

Testing and Quality Assurance:

  • Added a dist-clean target to clean up build artifacts, ensuring a fresh build environment (Makefile, MakefileR265-R286).

Documentation Improvements:

  • Enhanced clarity in the labels.md file by improving grammar and rephrasing descriptions (e.g., "Add environment variables from another service" instead of "antoher service") (doc/docs/labels.md, [1] [2].
  • Reorganized and corrected navigation in mkdocs.yml, fixing the casing of "LabelStructs" to "Labelstructs" for consistency (doc/mkdocs.yml, doc/mkdocs.ymlL63-L65).
  • Updated katenaryLabelsDoc.yaml with refined descriptions for better understanding (generator/labels/katenaryLabelsDoc.yaml, [1] [2].

Miscellaneous:

  • Improved the organization of the Makefile by grouping related targets under descriptive headers (e.g., "BUILD," "TESTS," "Miscellaneous") and adding comments for better readability (Makefile, [1] [2].
  • Removed the outdated auto-generated labelStructs.md file, likely replaced by newer documentation workflows (doc/docs/packages/generator/labels/labelStructs.md, doc/docs/packages/generator/labels/labelStructs.mdL1-L246).

These changes collectively enhance the project's build system, improve documentation quality, and reintroduce essential testing capabilities.

This pull request introduces several updates to the `Makefile` for improved build processes, new features, and better organization, alongside documentation improvements. Key changes include adding support for Windows installer generation, refining build modes, reintroducing testing commands, and enhancing documentation for clarity and consistency. ### Build Process Enhancements: * Added support for generating a Windows installer using NSIS, including downloading and configuring the required `EnVar.dll` plugin (`Makefile`, [MakefileR160-L166](diffhunk://#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52R160-L166)). * Introduced a `MODE` variable to differentiate between default and release build modes, modifying the `VERSION` string accordingly (`Makefile`, [MakefileR4-R41](diffhunk://#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52R4-R41)). * Updated the `dist` target to include signing, compression, and signature verification steps, and removed the deprecated `push-release` target (`Makefile`, [[1]](diffhunk://#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52L106-R123) [[2]](diffhunk://#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52L177-R228). ### Testing and Quality Assurance: * Added a `dist-clean` target to clean up build artifacts, ensuring a fresh build environment (`Makefile`, [MakefileR265-R286](diffhunk://#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52R265-R286)). ### Documentation Improvements: * Enhanced clarity in the `labels.md` file by improving grammar and rephrasing descriptions (e.g., "Add environment variables from another service" instead of "antoher service") (`doc/docs/labels.md`, [[1]](diffhunk://#diff-34f3e92e91dd96c1a0077f413284b7fc472a0ba1149b4c90ed3dde6f81399beaL3-R25) [[2]](diffhunk://#diff-34f3e92e91dd96c1a0077f413284b7fc472a0ba1149b4c90ed3dde6f81399beaL160-R169). * Reorganized and corrected navigation in `mkdocs.yml`, fixing the casing of "LabelStructs" to "Labelstructs" for consistency (`doc/mkdocs.yml`, [doc/mkdocs.ymlL63-L65](diffhunk://#diff-9b7694df3dff30659aadb24a152688c1d35774cc3514bf625a60eb71cea70922L63-L65)). * Updated `katenaryLabelsDoc.yaml` with refined descriptions for better understanding (`generator/labels/katenaryLabelsDoc.yaml`, [[1]](diffhunk://#diff-3f3baa90880ea351f0d54ec29417f1176a7f46ce440605c7fda777ef5e32e731L227-R227) [[2]](diffhunk://#diff-3f3baa90880ea351f0d54ec29417f1176a7f46ce440605c7fda777ef5e32e731L269-R269). ### Miscellaneous: * Improved the organization of the `Makefile` by grouping related targets under descriptive headers (e.g., "BUILD," "TESTS," "Miscellaneous") and adding comments for better readability (`Makefile`, [[1]](diffhunk://#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52L81-R97) [[2]](diffhunk://#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52R252-R253). * Removed the outdated auto-generated `labelStructs.md` file, likely replaced by newer documentation workflows (`doc/docs/packages/generator/labels/labelStructs.md`, [doc/docs/packages/generator/labels/labelStructs.mdL1-L246](diffhunk://#diff-42ba05ba4b99a17030c2f6c908eb89f78d093be384c17e1b745d997f60afe7feL1-L246)). These changes collectively enhance the project's build system, improve documentation quality, and reintroduce essential testing capabilities.
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
bug
Something isn't working
 dependencies
Pull requests that update a dependency file
 documentation
Improvements or additions to documentation
 duplicate
This issue or pull request already exists
 enhancement
New feature or request
 go
Pull requests that update go code
 good first issue
Good for newcomers
 help wanted
Extra attention is needed
 invalid
This doesn't seem right
 partially fixed
Some fixes are already made in current release / developpement
 question
Further information is requested
 wontfix
This will not be worked on
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
metal3d (Patrice Ferlet)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Katenary/katenary#131