Improve NuGet package items, automate publishing, add library comparison, and enhance documentation site#70
Draft
Copilot wants to merge 2 commits into
Draft
Conversation
…son section, and worked doc examples Agent-Logs-Url: https://github.com/simontreanor/FSharp.Finance.Personal/sessions/ecf32e77-40ac-4616-8bcc-27ba7320c1d7 Co-authored-by: simontreanor <4550815+simontreanor@users.noreply.github.com>
Author
Done — here's a summary of what was implemented in commit b65d9ed: 1. NuGet package improvements (
2. GitHub Actions — tag-triggered publishing (
3. README comparison section (
4. Documentation worked examples (
|
Copilot
AI
changed the title
[WIP] Improve NuGet package items and enhance documentation site
Improve NuGet package items, automate publishing, add library comparison, and enhance documentation site
Apr 29, 2026
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.
Several cross-cutting improvements to the repository's packaging, documentation, and discoverability.
Changes Made
1. NuGet package improvements (
src/FSharp.Finance.Personal.fsproj)PackageTagswith relevant keywords (fsharp, finance, apr, amortisation, mortgage, loan, hire-purchase, pcp, credit-card, uk, regulatory) for better NuGet discoverabilityPackageReleaseNotespointing to CHANGELOG.mdPackageDescriptionto clearly describe the library's capabilitiesGenerateDocumentationFile=true, ensuring IntelliSense works in consuming projects2. GitHub Actions — automated tag-triggered publishing (
.github/workflows/nuget.yml)push: tags:trigger so the workflow fires automatically when a version tag (e.g.2.5.6) is pushed, in addition to the existingworkflow_dispatchVERSIONenv var resolves fromgithub.ref_nameon a tag-triggered run, or from the manual input onworkflow_dispatchif: github.event_name == 'workflow_dispatch') when triggered by a tag push to avoid conflicts3. README library comparison section (
README.md)ExcelFinancialFunctionsandQuantLib4. Documentation worked examples (
docs/)examplePersonalLoan.fsx— £5,000 unsecured personal loan over 24 months at 9.9% APRexampleMortgage.fsx— £200,000 residential repayment mortgage over 25 years at 4.5%examplePcp.fsx— £22,000 PCP car finance with a £10,000 GFV balloon paymentexampleCreditCard.fsx— £2,000 credit card balance cleared at £50/month at 24.9% APRdocs/index.mdupdated to link to all four new examples under a "Product Examples" section