Add beman-tidy config to exemplar#368
Conversation
AndreiDurlea
requested review from
bretbrownjr,
camio,
dietmarkuehl,
ednolan,
neatudarius,
steve-downey and
wusatosi
as code owners
| disabled_rules: | ||
| # None | ||
| ignored_paths: | ||
| # None |
There was a problem hiding this comment.
The contents of this file should be as follows:
# This is the config file for beman-tidy, which checks compliance with the beman standard.
# Check documentation for beman-tidy here:
# https://github.com/bemanproject/beman-tidy/blob/main/README.md
{% if cookiecutter._generating_exemplar %}
disabled_rules:
- readme.title
{% else %}
disabled_rules:
# None
{% endif %}
ignored_paths:
# None
Then you can pass the cookiecutter CI without needing to make changes to check_cookiecutter.sh
There was a problem hiding this comment.
Nice! will apply this
There was a problem hiding this comment.
Agree with Eddie.
Also, thanks for adding this here! We need to reenable the test in beman-tidy repo!
There was a problem hiding this comment.
Just ran beman tidy on exemplar. Seems like we have to ignore some files/disable some more rules. Working on it!
There was a problem hiding this comment.
Also: pushing a PR to fix a small but critical bug regarding reading empty lists in an yaml.
There was a problem hiding this comment.
also, please wait for a new release of beman-tidy.
I'm doing one right now after your PR was merged into beman-tidy (bemanproject/beman-tidy#279). As per my understanding, you need here the capability of disabling rules, right?
If yes, we need to update https://github.com/bemanproject/exemplar/blob/main/cookiecutter/%7B%7Bcookiecutter.project_name%7D%7D/.pre-commit-config.yaml#L45
wait, @neatudarius can you postpone that release one min? I'm fixing a bug i just discovered
There was a problem hiding this comment.
PR with fix is open
bemanproject/beman-tidy#294
There was a problem hiding this comment.
|
coverage: 100.0%. remained the same — andreidurlea/beman-tidy-config into main |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
AndreiDurlea
force-pushed
the
andreidurlea/beman-tidy-config
branch
from
69e8317 to
281486c
Compare
|
Can we get this merged? In order to also fix CI on tidy (bemanproject/beman-tidy#296) and develop it further |
|
Just one thing first, can you squash all your commits into one commit and force push to this feature branch? The branch has 11 commits right now; I'd prefer for the exemplar repo to have a simpler git history. |
sure thing. will keep in mind for future PRs too |
AndreiDurlea
force-pushed
the
andreidurlea/beman-tidy-config
branch
from
281486c to
9dd8230
Compare
|
Squashed those, but github authored one more merge commit when updating this to be in sync w main. Hope it's ok git log
commit a615617f19e278545323586856748a928f822b96 (HEAD -> andreidurlea/beman-tidy-config, origin/andreidurlea/beman-tidy-config)
Merge: 9dd8230 1d90edb
Author: Andrei Durlea <[email protected]>
Date: Sat May 2 16:03:00 2026 +0300
Merge branch 'main' into andreidurlea/beman-tidy-config
commit 9dd8230e704dc6523428976d66e054b3c169b478
Author: Andrei Durlea <[email protected]>
Date: Sat May 2 16:01:42 2026 +0300
Add beman-tidy config to exemplar
: |
|
I'd prefer not to have merge commits; you should be able to eliminate it with a |
AndreiDurlea
force-pushed
the
andreidurlea/beman-tidy-config
branch
from
a615617 to
ea69220
Compare
|
Done 👍 |
4 participants
This PR is in anticipation of this PR on beman-tidy which introduces the possibility of disable entire rules. And in anticipation of undoing this temporary CI pause.
This does two things
.beman-tidy.yamlwith pre-ignored rules to fix CI on beman-tidycookiecutter/{{cookiecutter.project_name}}/.beman-tidy.yamlto the template in order to prep new repos with a.beman-tidy.yamlconfig file and how to use it