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: Change IGNORE_FILES setting default to all hidden files #3424

Merged
merged 1 commit into from
Nov 27, 2024

Conversation

projectgus
Copy link
Contributor

This is to avoid subtle behaviour that contributed to root cause of pelican-plugins/sitemap#36

Specifically: if installing Pelican into a local virtualenv with the pdm or uv default name ".venv", then subdirectories of .venv will contain all of the test .rst and .md files.

If you then run Pelican in that same root directory using the default PATH value (".") then it will add those content files to the site.

Pull Request Checklist

Resolves: #issue-number-here

  • Ensured tests pass and (if applicable) updated functional test output
  • Conformed to code style guidelines by running appropriate linting tools
  • Added tests for changed code
  • Updated documentation for changed code

(I haven't added a new test for the default setting, but I can if needed.)

This is to avoid subtle behaviour that contributed to root cause of
pelican-plugins/sitemap#36

Specifically: if installing Pelican into a local virtualenv with the pdm or uv
default name ".venv", then subdirectories of .venv will contain all of the test
.rst and .md files.

If you then run Pelican in that same root directory using the default PATH
value (".") then it will add those content files to the site.
@justinmayer justinmayer changed the title settings: Change the default IGNORE_FILES to all "hidden" files. feat: Change IGNORE_FILES setting default to all hidden files Nov 27, 2024
Copy link
Member

@justinmayer justinmayer left a comment

Choose a reason for hiding this comment

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

Thank you, Angus, for this improved default 👍

@justinmayer justinmayer merged commit 7096b0a into getpelican:main Nov 27, 2024
16 checks passed
@projectgus projectgus deleted the settings/ignore_files branch November 30, 2024 04:55
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.

2 participants