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.

Sign up for GitHub

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

Jump to bottom

Add automation to "validate" wikized references in articles #729

Open
bernhold opened this issue Mar 11, 2021 · 3 comments · May be fixed by #1937
Open

Add automation to "validate" wikized references in articles #729

bernhold opened this issue Mar 11, 2021 · 3 comments · May be fixed by #1937
Assignees
@markcmiller86
Labels
postponed-for-future-phase For item to be dealt with future phase of this project post-ECP Dec 2023 type: enhancement

Comments

@bernhold
Copy link
Member

This is a follow-on to #702, per discussion at 2021-03-11 EB meeting.

We should have an action that would check MD files in PRs for wikized references and fail if they need to be updated (i.e. let the user do it). We don't think it is appropriate to fully automate this (running and committing updated results). Safer to make the contributor update it. And other quality checks (e.g., spell checking) will require manual action anyway.
@bartlettroscoe
Copy link
Member

This should be merged into into the GHA mdchecks.yml workflow since that workflow already knows the list of modified *.md files. Should be easy to call a simple script that does this check and returns 0 or non-zero.

@markcmiller86 markcmiller86 self-assigned this Jun 24, 2021
@markcmiller86
Copy link
Member

This will be resolved with #927

@rinkug rinkug added the postponed-for-future-phase For item to be dealt with future phase of this project post-ECP Dec 2023 label Dec 14, 2023
@markcmiller86
Copy link
Member

Ok, so this is adding a CI action to run wikize_refs.py and if the output produced is different from the proposed file, it means that the user didn't run wikize_refs.py. There should be no difference if the file has been properly updated. So, this should be easy to add. We just fail with a message to re-run wikize_refs.py. I think I can do this relatively quickly.

@markcmiller86 markcmiller86 linked a pull request Dec 16, 2023 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@markcmiller86 markcmiller86

Labels
postponed-for-future-phase For item to be dealt with future phase of this project post-ECP Dec 2023 type: enhancement
Projects
BSSw Internal
Status: Selected for development
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add CI for wikize refs betterscientificsoftware/bssw.io
4 participants
@bernhold @rinkug @bartlettroscoe @markcmiller86