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

Code Quality: Simplify directories #323

Merged
merged 19 commits into from
Sep 19, 2024
Merged

Conversation

Lamparter
Copy link
Contributor

Related: #293 (hey there!)
This pull request was authored on behalf of @RiversideValley

Before the change?

  • Structure: solution default

After the change?

  • Structure: simplified directories

Pull request checklist

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

No


Hello (for the third time) 😁
In this PR, I (on behalf of @0x5bfa) have simplified the root directory/subdirectories to match common practices on GitHub. Took a while to get the configuration right, but everything builds correctly and packages are references as they should be. :octocat:

Copy link

github-actions bot commented Sep 7, 2024

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

Copy link
Contributor

@nickfloyd nickfloyd left a comment

Choose a reason for hiding this comment

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

These are great changes @Lamparter. A couple of things to get this all wrapped up...

  • You'l'l need to modify the workflow for the generator to make sure the models go in the src/ folder now > ./Octokit.GraphQL/ to ./src/Octokit.GraphQL/
  • This might also be a good time to move to .NET 8 / at least move the generator from netcoreapp3.1 to net8.0
  • As a factor of clean up we can delete .travis.yaml,appveyor.yaml, and the *.ncrunchsolution files
  • Given that this is already a "large" PR due to the move you might consider running the generator and checking in the results dotnet run --project ./Tools/Generate/Generate.csproj -- $GH_TOKEN ./Octokit.GraphQL/ to update all of the models
  • The dotnetcore.yml workflow should be updated as well to reflect the new structure
  • The integration-tests.yml workflow should be updated as well to reflect the new structure
  • The nuspec file Octokit.GraphQL.nuspec should be updated to reflect the new structure

@Lamparter
Copy link
Contributor Author

Lamparter commented Sep 17, 2024

Thanks for the review! Most of these change I've implemented (readme, src dir, net8.0) were suggested by the kind @0x5bfa so thank him for having lots of ideas for this project! ❤️ (you'll notice most of our changes are in our collaboration repo RiversideValley/Octokit)
I've mainly focused on .NET 8 in #321 so unless you want me to bring those changes here I'll keep these PRs separate 😅
I'll make sure to implement what you've requested and I'll run the source generator as well. 😁

@nickfloyd
Copy link
Contributor

I've mainly focused on .NET 8 in #321 so unless you want me to bring those changes here I'll keep these PRs separate 😅

Keep it there, I think that's the right move unless you run into anything that would prevent you from keeping them separate.

I'll make sure to implement what you've requested and I'll run the source generator as well. 😁
Sounds good! I'm looking forward to getting these changes in!

@0x5bfa
Copy link
Contributor

0x5bfa commented Sep 18, 2024

We should avoid updating models here.

Let's hold off:

  • Updating models
  • Updating projects to use .NET 8
  • Updating projects to be AoT compatible
  • Adding a new workflow to generate the models daily or weekly

A couple of things to get this all wrapped up...

Thank you for the review. If this is hard to review, we probably can separate the changes into a few PRs, merge into another branch on this repo and then merge that branch into the main.

@nickfloyd Here's the change list:

  • Move all source projects to "src" dir
  • Rename "Tools" to "tools"
  • Update some files to reflect these changes above
    • dotnetcore.yml
    • integration-tests.yml
    • generate-schema.yml
    • Octokit.GraphQL.nuspec
    • Octokit.GraphQL.sln (also now using the version of VS 2019 onwards)
  • Fixed an issue with dotnetcore.yml where it used a tooling no longer supported
  • Removed unnecessary files
    • appvayer.yml
    • .travis.yml
    • .gitmodules
    • *.v3.ncrunsolution
    • *.v3.ncrunproject

@Lamparter
Copy link
Contributor Author

@0x5bfa Where do you want to bring these changes?

@0x5bfa
Copy link
Contributor

0x5bfa commented Sep 18, 2024

To the upcoming PR.

@0x5bfa
Copy link
Contributor

0x5bfa commented Sep 18, 2024

I fixed the CI.
Probably it also should the following but I'd hold off for now

  • Use .NET 8
  • Rename to ci.yml or something not to include "netcore"

@Lamparter
Copy link
Contributor Author

https://github.com/octokit/octokit.graphql.net/actions/runs/10925402467/job/30326798453?pr=325#step:9:15
There are lots of NuGet warnings here, should fix (in another PR)

@nickfloyd
Copy link
Contributor

Hey @Lamparter & @0x5bfa thanks for the changes here ❤️. Everything looks good. Once you get the merge conflict resolved I'll get this merged in. Also, re: #321 - once you move that one out of draft I'll take a look at it.

Again, thank you both for making this and our community better!

@nickfloyd nickfloyd self-requested a review September 19, 2024 16:31
@nickfloyd nickfloyd merged commit 60704ed into octokit:main Sep 19, 2024
1 check passed
@0x5bfa
Copy link
Contributor

0x5bfa commented Sep 19, 2024

Some CI is failing, let's fix shortly.

@0x5bfa 0x5bfa deleted the directories branch September 19, 2024 19:48
@Lamparter
Copy link
Contributor Author

Oh crap I forgot to update the codebase structure in the README

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

Successfully merging this pull request may close these issues.

3 participants