Repository navigation
chore: align repository with IOExtend standards - #4
Merged
Merged
Conversation
Bring documentation, CI and project settings in line with RvtIO. - Generate the XML documentation file for the IOViewer package; the IsPackable condition in Directory.Build.props never matched. - Run the release workflow only for version tags, fail on gh errors and stop overwriting assets of an existing release. - Fail pack-release.ps1 when the source archive cannot be created. - Remove claims of .mtl and mesh simplification support from the docs. - Add the Autodesk trademark notice and use mahach666 as the copyright holder everywhere. - Describe supported versions, security scope, development setup and the clean-room policy in SECURITY.md and CONTRIBUTING.md. - Run tests on .NET 8 and .NET 10; pin SDK 10.0.100 without prerelease. - Add NuGet audit, Dependabot, .gitattributes and issue/PR templates.
4 tasks done
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.
What changes and why
Brings documentation, CI and project settings in line with the conventions used in RvtIO.
Fixes
IOViewerpackage was built without its XML documentation file: theIsPackablecondition inDirectory.Build.propsis evaluated before the project setsIsPackable, so it never matched. The flag now lives inIOViewer.csproj;lib/net8.0/IOViewer.xmlandlib/net10.0/IOViewer.xmlare in the package.release.ymlruns only for version tags again (noworkflow_dispatch), fails on anygh releaseerror and no longer overwrites assets of an existing release (--clobberremoved).tools/pack-release.ps1fails whengit archivefails and runs it against the repository root..mtlmaterial support or mesh simplification (LOD); neither exists in the code.Documentation
SECURITY.md: supported versions and scope (crafted inputs, HTML injection, output paths, the local--serveserver).CONTRIBUTING.md: development setup, clean-room and personal-data policy, code conventions, PR requirements.CHANGELOG.md: Keep a Changelog header and an[Unreleased]section.mahach666in LICENSE, package metadata and README.Repository settings
global.json: SDK 10.0.100,latestFeature, no prerelease; workflows useglobal-json-file, action versions match RvtIO..gitattributes(LF), issue and PR templates.threejsremoved from package tags (three.js is not used).How it was checked
dotnet build IOViewer.slnx -c Releasehas no warningsdotnet test IOViewer.slnx -c Releasepasses (11/11 on net8.0 and net10.0)Also ran
dotnet pack(XML docs present in the nupkg) anddotnet docfx docfx.json --warningsAsErrors(0 warnings).Notes for reviewers
v0.1.0tag was moved twice before; that path is intentionally closed.TimeLinerAPI, and the emptycatcharound opening the browser in--serve.