ionide / KeepAChangelog

Parser and MSBuild Targets for using Keep-A-Changelog-formatted Changelogs in your Build
MIT License
30 stars 4 forks source link

Improvements proposition #27

Closed MangelMaxime closed 2 weeks ago

MangelMaxime commented 9 months ago

WHAT

copilot:summary

copilot:poem

copilot:emoji

WHY

HOW

copilot:walkthrough

Sorry for the big PR, the auto formatting didn't help on that here πŸ™ˆ

I think copilot for PR is not available anymore so I will write a good old description myself ahah.

I was not able to test the Ionide.KeepAChangelog.Tasks project because when packing it there seems to be missing some dll.

I think this is something that was discovered with the last release already

➜  Thoth.Json.Core git:(feature/kevin_pr) βœ— dotnet pack
MSBuild version 17.8.3+195e7f5a3 for .NET
  Determining projects to restore...
  Restored /Users/mmangel/Workspaces/Github/thoth-org/Thoth.Json/packages/Thoth.Json.Core/Thoth.Json.Core.fsproj (in 800 ms).
/Users/mmangel/.nuget/packages/ionide.keepachangelog.tasks/900.2.0/build/Ionide.KeepAChangelog.Tasks.targets(29,9): error MSB4062: The "Ionide.KeepAChangelog.Tasks.ParseChangeLogs" task could not be loaded from the assembly /Users/mmangel/.nuget/packages/ionide.keepachangelog.tasks/900.2.0/build/../tasks/net6.0/Ionide.KeepAChangelog.Tasks.dll. Could not load file or assembly 'FSharp.Core, Version=6.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a'. The system cannot find the file specified. [/Users/mmangel/Workspaces/Github/thoth-org/Thoth.Json/packages/Thoth.Json.Core/Thoth.Json.Core.fsproj]
/Users/mmangel/.nuget/packages/ionide.keepachangelog.tasks/900.2.0/build/Ionide.KeepAChangelog.Tasks.targets(29,9): error MSB4062:  Confirm that the <UsingTask> declaration is correct, that the assembly and all its dependencies are available, and that the task contains a public class that implements Microsoft.Build.Framework.ITask. [/Users/mmangel/Workspaces/Github/thoth-org/Thoth.Json/packages/Thoth.Json.Core/Thoth.Json.Core.fsproj]
nojaf commented 9 months ago

If a code repository is not set up to use auto-formatting, you should not use a formatter in your PR! I tried to address this in https://github.com/ionide/KeepAChangelog/pull/24, but as long as the current code is not being checked on every commit you should not use a formatter.

This would have saved you a lot of effort, to be honest 😸

MangelMaxime commented 9 months ago

I agree problem was that it was setup to use it on save and saw it too late.

I will re-send the PR without the formatting change.

MangelMaxime commented 2 weeks ago

I am closing because I think going in the direction from #17 makes more sense.

Out sourcing the parser works would make it easier to maintain Ionide.KeepAChangelog.