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

🏗️🐞 presubmit verification of Markdown fails consistently #580

Closed
DerekNonGeneric opened this issue Oct 22, 2023 · 6 comments
Closed
Assignees
Labels
bug Something isn't working build claimed infrastructure linting Issues and PRs that deal with linting markdown An issue or PR related to Markdown needs-investigation testing tools Issues and PRs related to the tools directory

Comments

@DerekNonGeneric
Copy link
Member

Apparently the CI's in need of repair most likely due to breaking changes affecting the APIs of the plugins employed by the script that evaluates Markdown files: “verify.md” —

The script called "verify.md" which runs "node build/tasks/verify/verify-md.mjs" failed with exit code 1

 — the context of the above error message viewable in the below image.

image

Self-assigned; however, this will not be receiving our final intended solution to the pre-submit testing of Markdown expected to be done by our CI; commits addressing this issue should not be expected to implement our final ideal solution…


How we expect to achieve our final ideal solution begins to be hashed out by myself in the following thread on the topic.

🔗:https://twitter.com/DerekNonGeneric/status/1660506159978086403

So, yes, this codebase will need to undergo “comprehensive deregulation”. We do not plan on having this be the location where rules are defined or enforced/triaged, but more on that a little later tonight once we can get a green CI for merging our translations…

@DerekNonGeneric DerekNonGeneric added bug Something isn't working tools Issues and PRs related to the tools directory build linting Issues and PRs that deal with linting testing infrastructure markdown An issue or PR related to Markdown investigating claimed labels Oct 22, 2023
@DerekNonGeneric
Copy link
Member Author

DerekNonGeneric commented Oct 22, 2023

Tracking the current state of our CI system's brokenness: evidently, additional effort(s) may be req'd beyond simply getting the Markdown verification script working again  —

image

— Codacy is likewise red and blocking our twin translation PRs (#568, #569) from being merged.

Within the Codacy app, the culprits are clearly identified (e.g., failed quality gates); however, evidently, the apps' evals are not aligned w/ ours. We need to either inform that app of our preferences or simply remove its integration if it cannot be configured as we prefer as there's no justification left for its nagging about potential irrelevance.

image

@DerekNonGeneric DerekNonGeneric added the wip Issues and PRs that are still a work in progress label Oct 22, 2023
@DerekNonGeneric
Copy link
Member Author

Judging by the stack trace, the failing plugin employed within the Markdown verification script —

at file:///home/runner/work/.github/.github/.remarkrc.mjs:52:33

— the statement from this line is embedded for closer examination below…

.github/.remarkrc.mjs

Lines 52 to 72 in a1a5567

var naturalLanguage = unified().use([
await import('retext-english'),
await import('retext-syntax-urls'),
await import('retext-equality'),
await import('retext-passive'),
await import('retext-profanities'),
[await import('retext-readability'), { age: 21, minWords: 8 }],
await import('retext-repeated-words'),
[
await import('retext-simplify'),
{ ignore: ['function', 'interface', 'maintain'] },
],
[await import('retext-sentence-spacing'), { preferred: 1 }],
await import('retext-syntax-mentions'),
[
await import('retext-spell'),
{ dictionary: await import('dictionary-en'), personal: projectTerms },
],
await import('retext-syntax-urls'),
]);

@DerekNonGeneric
Copy link
Member Author

— Codacy is likewise red and blocking our twin translation

i have just now gone ahead and disabled Codacy (org-wide) seeing as how much of its checks would be repetitive or irrelevant, but we may find Codacy more useful once we are able to set aside the time necessary for it to be configured in such a way that it'd be a more suitable, dare i say (?), long-term solution

@OpenINFbot OpenINFbot added needs-investigation and removed wip Issues and PRs that are still a work in progress investigating labels Oct 22, 2023
@DerekNonGeneric DerekNonGeneric changed the title [bug: ci/cd] presubmit verification of Markdown fails consistently 🏗️🐞 presubmit verification of Markdown fails consistently Nov 11, 2023
@DerekNonGeneric
Copy link
Member Author

brief reminder about this one rule

image

@OpenINFbot
Copy link
Member

🔗 OpenINF/openinf.github.io#1215

@DerekNonGeneric
Copy link
Member Author

this is done for now — we are closing…

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working build claimed infrastructure linting Issues and PRs that deal with linting markdown An issue or PR related to Markdown needs-investigation testing tools Issues and PRs related to the tools directory
Projects
None yet
Development

No branches or pull requests

2 participants