Reorganize repository for unified release#39
Open
glopesdev wants to merge 4 commits into
Open
Conversation
Remove NSI scripts and move towards dotnet tool deployment.
Brings the repository into compliance with the standardised build infrastructure.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adopt the standardised repository layout described in harp-tech/protocol#145, aligning this repository with the conventions shared by other Harp components and enabling a unified release of firmware, software, and documentation from a single CI pipeline.
Repository layout and build infrastructure
Firmwarefolder becomesfirmware,Hardwarebecomeshardware, andInterfacebecomessoftware. A newdocs/folder is introduced as the root for repository documentation and assets.software/build/, includingCommon.csproj.props,Common.csproj.targets, andPackage.props, for consistent project metadata and packaging across software components.Self-contained documentation website
Add documentation scaffolding under
docs/, includingdocfx.json, template, articles, images, and workflows. The shared harp-tech/docfx-tools repository is included as thedocs/harp-docfxsubmodule. The site is built from the API metadata of the software components and published from the same CI pipeline that produces the firmware and software releases.Cross-platform App packaging
Replace the platform-specific NSIS installer with a cross-platform
dotnet toolpackage for the GUI App, installable on any platform with the .NET SDK and launchable asharp.behavior.Notes
After merging, contributors will need to run
git submodule update --init --recursiveanddotnet tool restorewhen checking out the repository.