Records the adoption trial of the shared quality checks in a real repository (MIL-003 task 4, issue #18). Documents only.
What was run
TirSystem-BashScript/RepoFoundry (another organization; 39 shell files, no Python), first on a throwaway branch and then as a pull request, RepoFoundry PR 76.
Run
shellcheck
shfmt -d
Python
Unchanged repository
PASS on all 39 files
FAIL on 10 files
skipped with a notice
With switch_case_indent = true under [*.sh] in .editorconfig
shellcheck needs no help when the project has a .shellcheckrc: the workflow runs from the repository root, so the project's settings applied and files that share variables across src/lib/*.sh produced no false positives.
shfmt follows a project's style only through .editorconfig. All ten differences were the indentation of case patterns: the workflow uses shfmt defaults and the project's own check is shfmt -i 2 -ci. One .editorconfig line fixed it without changing a script.
Reported paths are relative to working-directory, and a caller must reference the workflow at main or a tag: the first trial referenced the pull-request branch and lost the reference when it was merged and deleted.
Changes
docs/milestones/mil-003-quality-checks.md: section "Adoption in a real repository (task 4)", the task 4 row updated, a new Accepted version row.
docs/sqa/reviews/rc-039-mil-003-adoption.md: review record (QC-MIL-001, 6 of 6 Pass, Go; S01 standing in as ADR-0002 records).
TM-001 and the registry (next RC 040). No wiki pages changed.
Not complete yet
RepoFoundry PR 76 is open and not merged. The record says that the task closes when it is; this PR therefore uses Refs #18, not Closes. RC-039 has an action item to merge it and then close#18, and to put the three findings in the results guide (#19).
Records the adoption trial of the shared quality checks in a real repository (MIL-003 task 4, issue #18). Documents only.
## What was run
`TirSystem-BashScript/RepoFoundry` (another organization; 39 shell files, no Python), first on a throwaway branch and then as a pull request, [RepoFoundry PR 76](https://git.tirsystem.com/TirSystem-BashScript/RepoFoundry/pulls/76).
| Run | `shellcheck` | `shfmt -d` | Python |
| --- | --- | --- | --- |
| Unchanged repository | PASS on all 39 files | FAIL on 10 files | skipped with a notice |
| With `switch_case_indent = true` under `[*.sh]` in `.editorconfig` | PASS | PASS | skipped |
| The pull request itself (`languages: shell`) | PASS | PASS | not selected |
## Findings (for the guide, issue #19)
1. `shellcheck` needs no help when the project has a `.shellcheckrc`: the workflow runs from the repository root, so the project's settings applied and files that share variables across `src/lib/*.sh` produced no false positives.
2. `shfmt` follows a project's style only through `.editorconfig`. All ten differences were the indentation of `case` patterns: the workflow uses shfmt defaults and the project's own check is `shfmt -i 2 -ci`. One `.editorconfig` line fixed it without changing a script.
3. Reported paths are relative to `working-directory`, and a caller must reference the workflow at `main` or a tag: the first trial referenced the pull-request branch and lost the reference when it was merged and deleted.
## Changes
- `docs/milestones/mil-003-quality-checks.md`: section "Adoption in a real repository (task 4)", the task 4 row updated, a new `Accepted` version row.
- `docs/sqa/reviews/rc-039-mil-003-adoption.md`: review record (QC-MIL-001, 6 of 6 Pass, Go; S01 standing in as ADR-0002 records).
- TM-001 and the registry (next RC 040). No wiki pages changed.
## Not complete yet
RepoFoundry PR 76 is open and not merged. The record says that the task closes when it is; this PR therefore uses `Refs #18`, not `Closes`. RC-039 has an action item to merge it and then close #18, and to put the three findings in the results guide (#19).
Refs #18
Run against TirSystem-BashScript/RepoFoundry (39 shell files): shellcheck
passes with the project's .shellcheckrc, shfmt fails on 10 files only
because of the case indentation and passes after one .editorconfig line;
the pull request itself passes. Record the findings for the guide, review
the change (RC-039) and update TM-001. The adoption is complete when
RepoFoundry PR 76 is merged.
Task: MIL-003#4
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Records the adoption trial of the shared quality checks in a real repository (MIL-003 task 4, issue #18). Documents only.
What was run
TirSystem-BashScript/RepoFoundry(another organization; 39 shell files, no Python), first on a throwaway branch and then as a pull request, RepoFoundry PR 76.shellcheckshfmt -dswitch_case_indent = trueunder[*.sh]in.editorconfiglanguages: shell)Findings (for the guide, issue #19)
shellcheckneeds no help when the project has a.shellcheckrc: the workflow runs from the repository root, so the project's settings applied and files that share variables acrosssrc/lib/*.shproduced no false positives.shfmtfollows a project's style only through.editorconfig. All ten differences were the indentation ofcasepatterns: the workflow uses shfmt defaults and the project's own check isshfmt -i 2 -ci. One.editorconfigline fixed it without changing a script.working-directory, and a caller must reference the workflow atmainor a tag: the first trial referenced the pull-request branch and lost the reference when it was merged and deleted.Changes
docs/milestones/mil-003-quality-checks.md: section "Adoption in a real repository (task 4)", the task 4 row updated, a newAcceptedversion row.docs/sqa/reviews/rc-039-mil-003-adoption.md: review record (QC-MIL-001, 6 of 6 Pass, Go; S01 standing in as ADR-0002 records).Not complete yet
RepoFoundry PR 76 is open and not merged. The record says that the task closes when it is; this PR therefore uses
Refs #18, notCloses. RC-039 has an action item to merge it and then close #18, and to put the three findings in the results guide (#19).Refs #18