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

Call the mega-linter-runner installer to generate the examples in the docs #3073

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

echoix
Copy link
Collaborator

@echoix echoix commented Nov 4, 2023

Currently only in draft state, but it minimally is able to call the yeoman generator as a npm test. It can be saved to a file, so it can then be replaced in the docs.

Ideally, it would help out #3032

I want feedback on:

  • Where to save files
  • Should we remove the folder before and after inside the ./build.sh, or should we commit them as generated files
  • What options chosen in the generator would we like to show in the docs
  • Correct usage of modern node.js and mocha things. I don't know a lot about node.js, and I fought a lot for the yeoman test helper to be able to find the script and the template, so it may not seem right as it is now.
  • Should we generate for all the other CI providers (I think so)
  • The name of the script

Proposed Changes

Readiness Checklist

Author/Contributor

  • Add entry to the CHANGELOG listing the change and linking to the corresponding issue (if appropriate)
  • If documentation is needed for this change, has that been included in this pull request

Reviewing Maintainer

  • Label as breaking if this is a large fundamental change
  • Label as either automation, bug, documentation, enhancement, infrastructure, or performance

@echoix echoix marked this pull request as draft November 4, 2023 16:48
@echoix
Copy link
Collaborator Author

echoix commented Nov 4, 2023

See the example in the README of https://github.com/yeoman/yeoman-test (I didn't understand everything)

And some other partially outdated examples here https://yeoman.io/authoring/testing

Copy link
Contributor

github-actions bot commented Dec 5, 2023

This pull request has been automatically marked as stale because it has not had recent activity.
It will be closed in 14 days if no further activity occurs.
Thank you for your contributions.

If you think this pull request should stay open, please remove the O: stale 🤖 label or comment on the pull request.

@github-actions github-actions bot added the O: stale 🤖 This issue or pull request is stale, it will be closed if there is no activity label Dec 5, 2023
@echoix echoix added nostale This issue or pull request is not stale, keep it open and removed O: stale 🤖 This issue or pull request is stale, it will be closed if there is no activity labels Dec 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
nostale This issue or pull request is not stale, keep it open
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant