paket.exe pack --release-notes-file: format not documented in paket
Nobody has claimed this yet.
- Dominant language
- F#
- Stars
- 2.1k
- Forks
- 528
- Avg merge
- 1d 12m
- Merged PRs (30d)
- 54
Description
Description
The command paket.exe pack has a commandline option --release-notes-file in version 7.2.0+bb14ab674b2748070a624f394cd6796e11aaffa8. Unfortunately it seems that there are some expectations for the format as the command failes for a tested file.
Paket failed with
-> FileNotFoundException: Die Datei oder Assembly "Fake.Core.SemVer, Version=5.20.4.0, Culture=neutral, PublicKeyToken=null" oder eine Abhängigkeit davon wurde nicht gefunden. Das System kann die angegebene Datei nicht finden.
StackTrace:
bei Fake.Core.ReleaseNotes.parseAll(IEnumerable`1 data)
bei Fake.Core.ReleaseNotes.parse(IEnumerable`1 data)
bei Paket.Program.pack(ParseResults`1 results)
bei Paket.Program.handleCommand@897-23.Invoke(ParseResults`1 results)
bei Paket.Program.processWithValidationEx[a](FSharpFunc`2 printUsage, Boolean silent, FSharpFunc`2 validateF, FSharpFunc`2 commandF, a result)
bei Paket.Program.handleCommand(Boolean silent, Command command)
bei Paket.Program.main()
I can not find any description of the expectations for this file in the documentation or help of the application.
If there should be no requirements for the contents of this file, I will try to find a minimal sample to reproduce this failure.
Repro steps
As I currently suspect a missing documentation, there should not be a reproduction necessary.
Expected behavior
I thought the contents of the file specified for the option --release-notes-file are simply copied into the releaseNotes of the created Package.
Actual behavior
Paket is not able to create the nuget package and fails with
Paket failed with
-> FileNotFoundException: Die Datei oder Assembly "Fake.Core.SemVer, Version=5.20.4.0, Culture=neutral, PublicKeyToken=null" oder eine Abhängigkeit davon wurde nicht gefunden. Das System kann die angegebene Datei nicht finden.
StackTrace:
bei Fake.Core.ReleaseNotes.parseAll(IEnumerable`1 data)
bei Fake.Core.ReleaseNotes.parse(IEnumerable`1 data)
bei Paket.Program.pack(ParseResults`1 results)
bei Paket.Program.handleCommand@897-23.Invoke(ParseResults`1 results)
bei Paket.Program.processWithValidationEx[a](FSharpFunc`2 printUsage, Boolean silent, FSharpFunc`2 validateF, FSharpFunc`2 commandF, a result)
bei Paket.Program.handleCommand(Boolean silent, Command command)
bei Paket.Program.main()
Known workarounds
None
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the paket.exe pack --release-notes-file option and the Paket.Program.pack and Fake.Core.ReleaseNotes.parse entry points named in the report. Determine the expected release-notes format and document it, including a minimal valid example and how the option affects the generated package metadata.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- fsharp
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100