https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=39325

--- Comment #18 from Jonathan Druart <[email protected]> ---
Several "words" have been added to .codespell-ignore in order to make the
codespell tests pass. In a next step we will want to use the inline ignore. See
previous comment:
"""
Unfortunately we cannot use the "inline ignore" (yet) that is in 2.3.0 that
will be available in trixie (we have 2.2.2 in bookworm).
https://github.com/codespell-project/codespell/pull/2400
"""

Some manual changes are a bit messy (installer/data/mysql/db_revs/220600059.pl)
to trick codespell, but overall the automatic changes are correct and
everything was easy to deal with.

Test plan:
1. Apply the whole patchset, and the dependencies (if not pushed yet). There is
a remote branch available in my gitlab repo, with everything applied:
https://gitlab.com/joubu/Koha/-/commits/bug_39325
2. Squash the "Automatic fix" and the manual patches for easy review
3. Have a look at the generated commit and review every changes
4. Run `prove xt/author_codespell.t`. The only failures should be on
Koha/Schema/Result files.
5. Run the updatedatabase script and confirm that the typos have been fixed in
the DB (mostly in the COMMENTs)

Bonus, test the new version of the QA script
6. inside ktd, go to /kohadevbox/qa-test-tools and checkout the dedicated
branch
# as root
% git remote add joubu https://gitlab.com/joubu/qa-test-tools.git
% git checkout joubu/issue_93
# as koha user, go to /kohadevbox/koha and run the qa script
% qa

RM note: You will need to adjust the patch "Bug 39325: Exclude atomic update -
TODO RM": the atomicupdate path needs to be the one of the db_rev, so the tests
will ignore the file as it contains typo on purpose.
Also don't forget to regenerate the dbic schema files.


Several "words" have been added to .codespell-ignore to make the codespell
tests pass. In the next step, we will use inline ignores. See the previous
comment:

"""
Unfortunately, we cannot use the "inline ignore" feature (yet), which was
introduced in version 2.3.0 and will be available in Trixie (we currently have
2.2.2 in Bookworm).
https://github.com/codespell-project/codespell/pull/2400
""""

Some manual changes are a bit messy (e.g.,
installer/data/mysql/db_revs/220600059.pl) as a workaround for codespell, but
overall, the automatic changes are correct and easy to handle.

Test Plan:

1. Apply the entire patch set, along with its dependencies (if they haven't
been pushed yet). A remote branch with everything applied is available in my
GitLab repo:
    https://gitlab.com/joubu/Koha/-/commits/bug_39325
2. Squash the "Automatic fix" and manual patches for easier review.
3. Review the generated commit and verify all changes.
4.Run prove xt/author_codespell.t. The only expected failures should be in
Koha/Schema/Result files.
5.Run the updatedatabase script and confirm that the typos have been fixed in
the database (mostly in the COMMENT fields).

Bonus:
6. Test the new version of the QA script

Inside ktd, navigate to /kohadevbox/qa-test-tools and check out the dedicated
branch:

# As root:
% git remote add joubu https://gitlab.com/joubu/qa-test-tools.git
% git checkout joubu/issue_93

# As the koha user, navigate to /kohadevbox/koha and run the QA script:
% qa

RM Note:
You will need to adjust the patch "Bug 39325: Exclude atomic update - TODO RM".
The atomicupdate path must match the corresponding db_rev, so the tests
correctly ignore the file (as it contains intentional typos).
Also, don’t forget to regenerate the DBIC schema files.

-- 
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[email protected]
https://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/

Reply via email to