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

feat: adds auto generate showcases #1296

Merged
merged 9 commits into from
Jul 13, 2023
Merged

Conversation

WillHutt
Copy link
Contributor

@WillHutt WillHutt commented Jun 29, 2023

Type of change

  • Feature
  • Documentation change
  • Bug fix

Summary of change

  • Auto generates showcases based on package.jsons
  • Refactored the original kit to generate script

Checklist

  • These changes follow the contributing guidelines
  • This starter kit has been approved by the maintainers
  • Changes for this new starter kit are being pushed to an integration branch instead of main
  • All dependencies are version locked
  • This fix resolves [Pods] - Auto generate showcases #1292
  • I have verified the fix works and introduces no further errors

@netlify
Copy link

netlify bot commented Jun 29, 2023

Deploy Preview for starter-dev ready!

Name Link
🔨 Latest commit 72fe6ac
🔍 Latest deploy log https://app.netlify.com/sites/starter-dev/deploys/64af2faa83057c00080c484b
😎 Deploy Preview https://deploy-preview-1296--starter-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@WillHutt WillHutt marked this pull request as ready for review June 29, 2023 21:17
hdJerry
hdJerry previously approved these changes Jun 30, 2023
Copy link
Contributor

@hdJerry hdJerry left a comment

Choose a reason for hiding this comment

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

Look good to me.
I Leave it for others to review

Copy link
Contributor

@lindakatcodes lindakatcodes left a comment

Choose a reason for hiding this comment

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

This PR will likely be best held until the new design PR is approved and merged - there's a reasonable bit of crossover between the two and having the showcases doesn't make sense without that new design.

There will be a few places we'll need to adjust once the design PR (#1291 ) is merged:

  • in lib/parseKits, I think we'll be able to adjust that to pick the showcases from the package.json instead of having the variable there
  • the showcase variable will need to be removed from the config file
  • in that showcase variable we're also setting the icon - that doesn't seem to be handled in the current PR, so will need to be solved again

I've left a few other questions and suggestions for this PR, most fairly minor.

We should also update the root level README to indicate that new kits should include the "showcase" array, and what that should include / look like.

I also wonder if we need to update the packages/website predev and prebuild scripts to also generate the showcases? We'll likely need that to ensure things are kept up to date as well.

packages/website/scripts/generate-kit-pages.js Outdated Show resolved Hide resolved
packages/website/scripts/generate.js Outdated Show resolved Hide resolved
packages/website/scripts/generate.js Outdated Show resolved Hide resolved
packages/website/src/showcases/showcases.json Outdated Show resolved Hide resolved
@WillHutt
Copy link
Contributor Author

Yeah, I was initially planning on #1291 being merged before this was completed, but that had a few rounds of changes and is still ongoing.

I was considering pushing this into #1291, but I also didn't want to hold that up with any feedback on this and cause a massive delay on it like in previous PRs/tickets.

With that route chosen, I ended up removing the hook-up functionality I had originally implemented for instance

  • The lib/parseKits adjustments
  • Removal of the showcase variable from the config file
  • The icon being handled since that isn't set in the package.json

I was going to create a new ticket that would focus on combining those above-needed changes with the new updates from #1291.

I'm good with either outcome and I will be pushing a new commit that should address a majority of the feedback you've given. 😄

@lindakatcodes
Copy link
Contributor

@WillHutt The design changes from #1291 is now merged into main! You should be good to rebase this PR when you come back and move forward from there. 👍🏼

Copy link
Contributor

@lindakatcodes lindakatcodes left a comment

Choose a reason for hiding this comment

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

Looks solid to me! The only tiny nitpick I'd make is - the array in each kit's package.json file, can we name it "showcases" instead of "showcase" (make it plural)? Since the idea is that we'll eventually have multiple showcases? Otherwise, this feels good!

@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@WillHutt WillHutt requested a review from lindakatcodes July 12, 2023 23:04
Copy link
Contributor

@lindakatcodes lindakatcodes left a comment

Choose a reason for hiding this comment

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

:shipit:

@WillHutt WillHutt merged commit 8c63811 into main Jul 13, 2023
@WillHutt WillHutt deleted the feat/1292-auto-generate-showcases branch July 13, 2023 13:39
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.

[Pods] - Auto generate showcases
3 participants