Skip to content

Don't check for appearances of the string "exemplar" in infra/ directory of cookiecutter output#185

Merged
ednolan merged 1 commit intomainfrom
enolan_cookiecuttercheckinfra1
Jun 24, 2025
Merged

Don't check for appearances of the string "exemplar" in infra/ directory of cookiecutter output#185
ednolan merged 1 commit intomainfrom
enolan_cookiecuttercheckinfra1

Conversation

@ednolan
Copy link
Copy Markdown
Member

@ednolan ednolan commented Jun 24, 2025

Normally, the CI check for cookiecutter attempts to ensure that the string "exemplar" doesn't appear in the cookiecutter output in order to verify that the maintainer didn't miss a template.

However, there are uses of that string for unrelated reasons in infra/, for example:

Untemplated "exemplar" in cookiecutter:
/tmp/tmp.HlSzWR1S2v/RLZrmX9NfS/infra/tools/beman-tidy/beman_tidy/lib/utils/string.py-    return name[:6] == "beman." and is_snake_case(name[6:]) and not re.match(".*[0-9]+$", name[6:])
/tmp/tmp.HlSzWR1S2v/RLZrmX9NfS/infra/tools/beman-tidy/beman_tidy/lib/utils/string.py-
/tmp/tmp.HlSzWR1S2v/RLZrmX9NfS/infra/tools/beman-tidy/beman_tidy/lib/utils/string.py-
/tmp/tmp.HlSzWR1S2v/RLZrmX9NfS/infra/tools/beman-tidy/beman_tidy/lib/utils/string.py-def match_badges(string):
/tmp/tmp.HlSzWR1S2v/RLZrmX9NfS/infra/tools/beman-tidy/beman_tidy/lib/utils/string.py-    """
/tmp/tmp.HlSzWR1S2v/RLZrmX9NfS/infra/tools/beman-tidy/beman_tidy/lib/utils/string.py:    e.g., ![Library Status](https://raw.githubusercontent.com/bemanproject/beman/refs/heads/main/images/badges/beman_badge-beman_library_under_development.svg) ![Continuous Integration Tests](https://github.com/bemanproject/exemplar/actions/workflows/ci_tests.yml/badge.svg) ![Lint Check (pre-commit)](https://github.com/bemanproject/exemplar/actions/workflows/pre-commit.yml/badge.svg)

This commit addresses the issue by removing the "infra" directory before performing the check.

…ory of cookiecutter output

Normally, the CI check for cookiecutter attempts to ensure that the
string "exemplar" doesn't appear in the cookiecutter output in order
to verify that the maintainer didn't miss a template.

However, there are uses of that string for unrelated reasons in
infra/, for example:

Untemplated "exemplar" in cookiecutter:
/tmp/tmp.HlSzWR1S2v/RLZrmX9NfS/infra/tools/beman-tidy/beman_tidy/lib/utils/string.py-    return name[:6] == "beman." and is_snake_case(name[6:]) and not re.match(".*[0-9]+$", name[6:])
/tmp/tmp.HlSzWR1S2v/RLZrmX9NfS/infra/tools/beman-tidy/beman_tidy/lib/utils/string.py-
/tmp/tmp.HlSzWR1S2v/RLZrmX9NfS/infra/tools/beman-tidy/beman_tidy/lib/utils/string.py-
/tmp/tmp.HlSzWR1S2v/RLZrmX9NfS/infra/tools/beman-tidy/beman_tidy/lib/utils/string.py-def match_badges(string):
/tmp/tmp.HlSzWR1S2v/RLZrmX9NfS/infra/tools/beman-tidy/beman_tidy/lib/utils/string.py-    """
/tmp/tmp.HlSzWR1S2v/RLZrmX9NfS/infra/tools/beman-tidy/beman_tidy/lib/utils/string.py:    e.g., ![Library Status](https://raw.githubusercontent.com/bemanproject/beman/refs/heads/main/images/badges/beman_badge-beman_library_under_development.svg) ![Continuous Integration Tests](https://github.com/bemanproject/exemplar/actions/workflows/ci_tests.yml/badge.svg) ![Lint Check (pre-commit)](https://github.com/bemanproject/exemplar/actions/workflows/pre-commit.yml/badge.svg)

This commit addresses the issue by removing the "infra" directory
before performing the check.
@ednolan ednolan requested review from a team and inbal2l June 24, 2025 11:21
@ednolan ednolan merged commit f15b8f6 into main Jun 24, 2025
70 checks passed
@ednolan ednolan deleted the enolan_cookiecuttercheckinfra1 branch June 24, 2025 12:09
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.

1 participant