[Add] v1 release infrastructure: CITATION.cff, nuget-release workflow, README getting-started#49
Merged
Merged
Conversation
…flow, README getting-started (#21)
Contributor
|
|
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.



Toward #21 (v1 release). Adds the release infrastructure — the parts that are code/config in the repo. The remaining items are release execution (choosing the version, adding the NuGet secret, running the workflow) and are called out below rather than done here.
What this adds
CITATION.cff— org-standard citation metadata, mirroring uml4net's structure (top-level +preferred-citation). The release workflow bumps itsversion/date-releasedat release time..github/workflows/nuget-release.yml— a manual, versioned release workflow (workflow_dispatchwith a SemVerversioninput), adapted from uml4net'snuget-release.yml:CITATION.cff, buildsRELEASE_NOTES.mdfrom each csproj'sPackageReleaseNotes;dotnet pack -c Release Auriga.sln→ pushes*.nupkg(+.snupkgsymbols) to nuget.org with--skip-duplicate;CodeQuality.yml); the GitHub release is created via the preinstalledghCLI to avoid an unpinnable third-party action.dotnet add packagelines plus a load → navigate layers → query → write-back snippet using the real API (CapellaProject.Load, the layer properties, theAuriga.Extensionsqueries,XmiWriterBuilder).Already in place (verified, not changed)
Directory.Build.props(GenerateSBOM=trueviaMicrosoft.Sbom.Targets,snupkg,PublishRepositoryUrl, README/LICENSE/NOTICE packed,GenerateDocumentationFile=true).Auriga.CodeGeneratorandAuriga.ReportingareIsPackable=false, sodotnet pack Auriga.slnproduces exactly Auriga, Auriga.Xmi, Auriga.Extensions (+ symbol packages).NOTICEandLICENSE(Apache-2.0) are present and packed.Not done here — needs a maintainer (why #21 stays open)
NUGET_API_KEYrepository secret, then dispatch Nuget-Release with the chosen version.<Version>in the csprojs is currently0.1.0; decide v1 vs. a0.xpreview and bump the three csprojs + theirPackageReleaseNotesbefore releasing.Auriga.Reporting/HtmlDocs). If a separate hosted API-doc site is wanted, that tooling choice is a maintainer decision (uml4net ships XML docs similarly, with no separate API-doc-publish workflow).Verification
CapellaProject,Auriga.Extensions,XmiWriterBuilder). No production code changed.