Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump the Cake.Core package to 4.0.0 #124

Merged
merged 19 commits into from
Jul 8, 2024
Merged

Conversation

raman-m
Copy link
Contributor

@raman-m raman-m commented Apr 10, 2024

Fixes #123

This PR upgrades the Cake.Core version to 4.0.0 which was released on Nov 19, 2023.
With minor refactoring, with checking and fixing errors/warnings/messages of StyleCop and IDE code analyzers.

Description

  • Bumped Cake.Core to 4.0.0 and other packages to the latest versions, see commit 0407e04
  • Removed unsupported Cake.Addin.Analyzer, the latest version 0.1.3 was released on Mar 3, 2021, see commit acaa3f7
  • Fixed the first StyleCop warnings, see commits c44057a and c88a432
  • Added .editorconfig to the solution because it is best practice for code analysis, see commit 42aa7f7
  • Fixed Cake Contrib Guidelines analysis error CCG0008 related to usage of recommended tags, see commit 634170b
  • Setup code analysis and StyleCop having updated solution & project files, see commit bd71595
  • Fixed StyleCop warnings: SA1210 (2c473db), SA1518 (fb0c16a), SA1600 (3ed30e3) and SA0001 (f352054)
  • Fixed CSharp analysis messages for testing project: CS1591 (206cd63)
  • Followed IDE Code Analysis suggestion: CA1510 (1ffc8d3)
  • Followed IDE Code Analysis suggestions: IDE0017 (d559ded) and IDE0066 (778f866)
  • Disabled 2 features which are available in .NET 8 (C# 12) only by IDE Code Analysis suggestions: IDE0290 (c080309) and IDE0300 (9efd482)

Related Issue

Motivation and Context

This change is required because of #123
After major release of referenced packages, Cake.Core one in our case, the packs versions must be updated.

How Has This Been Tested?

To be provided...

Screenshots (if appropriate):

image

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes. Note by @raman-m: No actual changes means no new tests.
  • All new and existing tests passed.

@raman-m
Copy link
Contributor Author

raman-m commented Apr 10, 2024

@gep13 Hey Gary!

I’d appreciate it if you could find some time to review, merge into the develop branch, and then release the next version, please!

@raman-m
Copy link
Contributor Author

raman-m commented Apr 19, 2024

@devlead Hello Mattias!
Do you know who maintains the repository currently?

Workflow status

1 workflow awaiting approval
This workflow requires approval from a maintainer.

@raman-m
Copy link
Contributor Author

raman-m commented Jun 25, 2024

@gep13 Gary
@devlead Mattias
Another notification has been issued for a new release due to Cake 4.0. I am confident that my pull request is of sufficient quality to be merged and released.

@raman-m
Copy link
Contributor Author

raman-m commented Jun 25, 2024

@gep13 @nmbro @Jericho @daveaglick @derhally @augustoproiete @Sharparam @devlead @larzw @RLittlesII @jokay
Hello everyone, I apologize for directly tagging all of you!
Could anyone inform me who currently owns this repository? Who is responsible for reviewing PRs and managing releases?
Thank you kindly for directing me to the appropriate GitHub individuals.

Copy link
Contributor

@nmbro nmbro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changes look good at a glance.

I remember @pascalberger being pretty active in the cake-contrib repos

And for the love of everything holy - remember to squash if this gets merged :)

@raman-m raman-m requested a review from nmbro June 26, 2024 12:18
@nils-a
Copy link
Contributor

nils-a commented Jun 27, 2024

@raman-m thank you for the contribution.
I have spoken to @gep13 and I will start bringing this repo up-to-speed in the coming days.

However, rather than doing one big jump to Cake 4, I will do small steps and create intermediate releases for Cake 2.0 and 3.0 between.
I will do that, since there are people out there stuck on one version or another for different reasons..

If it's ok for you, I'll probably cherry-pick some of your commits along the way..

@raman-m
Copy link
Contributor Author

raman-m commented Jul 2, 2024

@nils-a Hi Nils!

However, rather than doing one big jump to Cake 4, I will do small steps and create intermediate releases for Cake 2.0 and 3.0 between.

Indeed, releasing previous versions of Core is a sensible approach.

If it's ok for you, I'll probably cherry-pick some of your commits along the way..

That's fine! There's no need to cherry-pick. I'll rebase the feature branch following the official release for versions 2 and 3. However, do let me know if you require any assistance.

P.S. I will resolve conflicts later after the releases.

@nils-a
Copy link
Contributor

nils-a commented Jul 8, 2024

@raman-m it is done: I released Cake.Coveralls 3.0.0 which added support for Cake 3.0.0. If you like, you can start resolving conflicts, now. 😬 I hope I have not made too many changes that collide with this PR.

@raman-m
Copy link
Contributor Author

raman-m commented Jul 8, 2024

Going to rebase the feature branch and resolve merge conflicts...

raman-m added 18 commits July 8, 2024 17:35
CCG0006: No '.editorconfig' found in folder-structure. Usage of '.editorconfig' is strongly recommended.
See https://cake-contrib.github.io/CakeContrib.Guidelines/rules/ccg0006
…gs for the project.

Editor Config -> New line preferences -> Insert Final Newline = true
Note: All files should end with new line because of GitHub diff tool which highlights absent new line
XML docs for test classes are nor required
Each project should be configured to include an XML documentation file with the compiled output.
Disable IDE0290 because the feature is available in .NET 8 (C# 12) only
Disable IDE0300 because the feature is available in .NET 8 (C# 12) only
@raman-m
Copy link
Contributor Author

raman-m commented Jul 8, 2024

@nils-a, if it's alright with you, I can implement the Visual Studio refactoring Quick Action, also known as "Convert to file-scoped namespace", across all C# files. File-scoped namespaces have been available since .NET 6 vs C# 10.
What are your thoughts?

P.S. FYI

The feature branch has been rebased onto cake-contrib:develop

@nils-a
Copy link
Contributor

nils-a commented Jul 8, 2024

While I, personally, like it, I'd rather have @gep13 input on that question.
Also, if we're going to implement it, I'd rather have it as an individual PR.

So, no, for now let's not do that.

@raman-m raman-m requested a review from nils-a July 8, 2024 15:26
@raman-m raman-m mentioned this pull request Jul 8, 2024
9 tasks
@nils-a nils-a enabled auto-merge July 8, 2024 16:38
@nils-a nils-a disabled auto-merge July 8, 2024 16:39
@nils-a nils-a enabled auto-merge (squash) July 8, 2024 16:40
Copy link
Contributor

@nils-a nils-a left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@raman-m
Copy link
Contributor Author

raman-m commented Jul 8, 2024

Should I close conversation threads?

@nils-a nils-a merged commit 29859a7 into cake-contrib:develop Jul 8, 2024
5 checks passed
@nils-a
Copy link
Contributor

nils-a commented Jul 8, 2024

@raman-m your changes have been merged, thanks for your contribution 👍

I will fix two more issues, and then I will release the v4.0.0.

@gep13
Copy link
Member

gep13 commented Jul 8, 2024

@nils-a said...
While I, personally, like it, I'd rather have @gep13 input on that question.

I don't have any strong opinion either way. Personally, I don't really like it, but I am an old .NET Developer, who is stuck in their ways! Long live string.Format

@nils-a said...
Also, if we're going to implement it, I'd rather have it as an individual PR.

I think that this would be the correct approach.

@raman-m
Copy link
Contributor Author

raman-m commented Jul 9, 2024

Thank you for merging it!
I am looking forward to the v4 release so I can enable and test the new version with the build script in my project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Outdated version 1.0.0 of referenced Cake.Core package
4 participants