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

Expand examples_do_not_have_gitignore test #1417

Closed
smoelius opened this issue Nov 18, 2024 · 6 comments · Fixed by #1461
Closed

Expand examples_do_not_have_gitignore test #1417

smoelius opened this issue Nov 18, 2024 · 6 comments · Fixed by #1461

Comments

@smoelius
Copy link
Collaborator

smoelius commented Nov 18, 2024

To examples_do_not_contain_forbidden_paths or something similar:

fn examples_do_not_have_gitignore() {

The test should continue check that the following is not in any example subdirectory:

  • .gitignore

The test should additionally check that the following are not in any non-root subdirectory of the general, supplementary, or restriction subdirectories:

  • .cargo/config.toml
  • rust-toolchain

However, the test should allow those files to exist in the experimental and testing subdirectories, e.g., like here:

@smoelius smoelius changed the title Exapnd examples_do_not_have_gitignore Expand examples_do_not_have_gitignore Nov 18, 2024
@smoelius smoelius changed the title Expand examples_do_not_have_gitignore Expand examples_do_not_have_gitignore test Nov 18, 2024
@0x471
Copy link
Contributor

0x471 commented Dec 28, 2024

Hi, can I work on this issue? @smoelius

@smoelius
Copy link
Collaborator Author

@0x471 Yes, please do!

@smoelius
Copy link
Collaborator Author

I just clarified the issue description a little bit. I think the changes are small. Hopefully, you agree.

@0x471
Copy link
Contributor

0x471 commented Dec 28, 2024

Thank you for the details, feel free to check the PR!

it seems the test is currently failing because there’s a rust-toolchain file in the general examples folder. According to the issue description, this file shouldn’t be there.

How do you suggest proceeding with this?

@smoelius
Copy link
Collaborator Author

it seems the test is currently failing because there’s a rust-toolchain file in the general examples folder.

That's okay, actually.

In fact, my reason for wanting to expand the test is to ensure that no file in a subdirectory overrides those.

I'm not sure the easiest/best way to suggest allowing exceptions for the roots of the general, supplementary, and restriction subdirectories. Can I leave it to you to decide?

P.S. I just tweaked the description again. Sorry for being imprecise.

@0x471
Copy link
Contributor

0x471 commented Dec 29, 2024

I modified the test accordingly, added a new array for root directories with exceptions: f49cf23

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 a pull request may close this issue.

2 participants