Add spellcheck workflow #138

sjspielman · 2024-03-11T15:46:46Z

Purpose

This PR adds the spellcheck workflow. The workflow is setup with three triggers which have the following behavior:

Temporary trigger of PRs to `main`

We should use this during docs development to check typos as we go. Before onboarding contributors, we should disable this trigger and the associated step post-to-pr (needs 🎟️ ).

cron job and manual dispatch

These are the triggers we expect to use when OpenScPCA gets up and running.

First, GHA cron syntax will not let us run every X weeks, but I found what I think it's a fairly reasonable "hack" that I added for this as posted in #84 (comment). We set a start date (I've put in next sprint for this; note that I've tested this putting in today and it seems to work), and then check if the date the action is trying to run on is actually a multiple of 4 weeks later.
Spellchecking is run if either we're not running as a cronjob, or we're at 4 weeks later.

For both cron & manual, we'll want to end up opening an issue and linking in the artifact file. I've created a template for that issue. Currently those steps are uncommented for a test, but I expect to comment them out for now during dev and revive them at launch (again, we need a 🎟️ ).

Issue Addressed

Closes #84

Any comments, concerns, or questions important for reviewers

No specific comments other than, what looks good to keep and/or discard?

…ps (for dev) to test

sjspielman · 2024-03-11T15:55:06Z

Hm, I would have expected checkout to work with the default token value, but I don't have access to repo admin settings to make sure everything is setup there. @jashapiro ?

https://github.com/AlexsLemonade/OpenScPCA-analysis/actions/runs/8235720594/job/22520486950#step:3:53

.github/workflows/spellcheck.yml

Co-authored-by: Joshua Shapiro <josh.shapiro@ccdatalab.org>

sjspielman · 2024-03-11T17:45:02Z

Confirming that issue opening works, so I'm now going to comment out those parts of the GHA #141 to avoid spam during docs development.

README.md

github-actions · 2024-03-11T19:56:37Z

Spellcheck failed!
Here are the errors.

…tionary

github-actions · 2024-03-11T20:07:50Z

Spellcheck failed!
Here are the errors.

.github/workflows/spellcheck.yml

jashapiro · 2024-03-11T20:11:16Z

Spellcheck failed! Here are the errors.

This is a kind of annoying way to get the errors, since you have to unzip them. Maybe just cat them as a step in the workflow and link to that step if possible?

jashapiro · 2024-03-11T20:14:22Z

Spellcheck failed! Here are the errors.

This is a kind of annoying way to get the errors, since you have to unzip them. Maybe just cat them as a step in the workflow and link to that step if possible?

Another idea is just to have the "fail" step cat the error file before dying. That will display them when clicking "details"

sjspielman · 2024-03-11T20:54:25Z

This is a kind of annoying way to get the errors, since you have to unzip them. Maybe just cat them as a step in the workflow and link to that step if possible?

(I don't really find this annoying, but I understand this is up for debate!).
I'm looking into a nice way to do this, but getting foiled for reasons I don't understand. Any insights or suggestion for different approach?

I added the step (syntax: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#example-of-a-multiline-string)

      - name: Get the contents
        id: get-typos
        run: |
          {
            echo 'typos<<EOF'
            cat spell_check_errors.tsv
            echo EOF
          } >> "$GITHUB_OUTPUT"

And then changed the PR comment step to print this out, but it's not being printed... I changed the cat spell_check_errors.tsv to just echo "stephanie" and had no luck there either which confused me, since I thought the problem might be something with the artifact but I guess not! Have to head out now but will be back later to poke around.

jashapiro

I'm sorry I was unclear! I was suggesting something much simpler than what you are trying to do. Just printing the output table within the workflow step that triggers the failure means that you should see it right away when clicking the failure link either in the email or on the PR page.

.github/workflows/spellcheck.yml

Co-authored-by: Joshua Shapiro <josh.shapiro@ccdatalab.org>

github-actions · 2024-03-12T13:31:38Z

Spellcheck failed!
Here are the errors.

jashapiro · 2024-03-12T13:44:22Z

.github/workflows/spellcheck.yml

+      - name: Post errors to PR if failed
+        if: ${{ github.event_name == 'pull_request' && steps.spell.outputs.error_count > 0 }}
+        uses: peter-evans/create-or-update-comment@v4
+        id: post-to-pr
+        with:
+          issue-number: ${{ github.event.pull_request.number }}
+          body: |
+            **Spellcheck failed!**
+            To see the errors, either you can [download this zip file](${{ steps.artifact-upload-step.outputs.artifact-url }}) or click `Details` in the failed action check.


I'd prefer that this step be removed entirely. The reason is that everybody watching the repo and/or who has commented on the PR will get notifications of these comments, and that is part of what annoys me. The only person who needs to see this is the person who pushed the most recent changes, and they will be notified by the action failure.

jashapiro

LGTM, ∂ some small dictionary changes which probably means some other text changes.

jashapiro · 2024-03-12T15:04:26Z

.github/components/dictionary.txt

+OpenScPCA
+openscpca
+pre
+Pre


Probably not needed, but doesn't hurt

.github/components/dictionary.txt

jashapiro · 2024-03-12T15:07:28Z

.github/components/dictionary.txt

+trainings
+transphobic
+triaged
+WisCon


I need to know

We apparently use some of their language in CoC

jashapiro · 2024-03-12T15:12:24Z

.github/workflows/spellcheck.yml

+          echo "FIRST_RUN_DATE: ${{ env.FIRST_RUN_DATE }}" >> $GITHUB_STEP_SUMMARY
+          echo "current_date: $current_date" >> $GITHUB_STEP_SUMMARY
+          echo "weekdiff: $weekdiff" >> $GITHUB_STEP_SUMMARY
+          echo "weekindex: $weekindex" >> $GITHUB_STEP_SUMMARY


We probably don't need a step summary for this?

Co-authored-by: Joshua Shapiro <josh.shapiro@ccdatalab.org>

jashapiro · 2024-03-12T15:24:00Z

.github/components/dictionary.txt

+reproducibility
+ScPCA
+socio
+Stumptown


I guess I also want to know how this sneaks in. @jaclyn-taroni?

Stumptown Syndicate’s Citizen Code of Conduct.

Hm this website isn't loading though... Do we want to swap the link to https://github.com/stumpsyn/policies/blob/master/citizen_code_of_conduct.md ?

the Ubuntu and RLadies links changed also it looks like, so I went ahead and made sure all the links work while I was here.

sjspielman added 3 commits March 11, 2024 11:32

add issue template for spellcheck cron job

8a029ca

Add spellcheck workflow, including both issue (for launch) and PR ste…

b24e437

…ps (for dev) to test

update startdate, add concurrency, clean up comments

c47d6ec

sjspielman marked this pull request as draft March 11, 2024 15:48

jashapiro reviewed Mar 11, 2024

View reviewed changes

.github/workflows/spellcheck.yml Outdated Show resolved Hide resolved

Update .github/workflows/spellcheck.yml

cb5daa1

Co-authored-by: Joshua Shapiro <josh.shapiro@ccdatalab.org>

sjspielman added 5 commits March 11, 2024 13:46

test with a spelling error

44b4f5b

comment out steps that file the spellcehck issue

c1b8e5f

add dictionary file with ScPCA

925eead

new spelling error

23703d2

parsing wants a new line

084ff0d

sjspielman commented Mar 11, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

jashapiro mentioned this pull request Mar 11, 2024

Add check for blank second arg AlexsLemonade/spellcheck#8

Merged

test: explicitly check README only

56f2b9d

undo README-only check as it worked as expected. Add OpenScPCA to dic…

f810daa

…tionary

jashapiro closed this in AlexsLemonade/spellcheck#8 Mar 11, 2024

jashapiro reopened this Mar 11, 2024

bump spellcheck to 0.1.1

e429060

jashapiro reviewed Mar 11, 2024

View reviewed changes

.github/workflows/spellcheck.yml Outdated Show resolved Hide resolved

WIP: finding a way to cat the spell check errors

5330bbe

jashapiro mentioned this pull request Mar 12, 2024

make push more discriminating AlexsLemonade/spellcheck#9

Merged

jashapiro reviewed Mar 12, 2024

View reviewed changes

.github/workflows/spellcheck.yml Outdated Show resolved Hide resolved

.github/workflows/spellcheck.yml Outdated Show resolved Hide resolved

Apply suggestions from code review

e7fbe8a

Co-authored-by: Joshua Shapiro <josh.shapiro@ccdatalab.org>

fix the spelling errors and add to dictionary

6951c7f

sjspielman marked this pull request as ready for review March 12, 2024 13:38

modify issue comment, noting this step may not end up there in the end

56ba3af

sjspielman requested a review from jashapiro March 12, 2024 13:40

jashapiro reviewed Mar 12, 2024

View reviewed changes

remove pr comment step and pr write permissions

94aee23

jashapiro approved these changes Mar 12, 2024

View reviewed changes

sjspielman and others added 4 commits March 12, 2024 11:21

Apply suggestions from code review

96b15fe

Co-authored-by: Joshua Shapiro <josh.shapiro@ccdatalab.org>

Github -> GitHub

10f1133

only lowercase pre

d138505

remove step summary from the weekindex code

fb63c49

jashapiro reviewed Mar 12, 2024

View reviewed changes

Fix a couple broken URLs in the code of conduct since it came up

19a75cf

sjspielman merged commit e805a19 into main Mar 12, 2024
3 checks passed

sjspielman deleted the sjspielman/84-spellcheck-workflow branch March 12, 2024 15:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add spellcheck workflow #138

Add spellcheck workflow #138

sjspielman commented Mar 11, 2024

sjspielman commented Mar 11, 2024

sjspielman commented Mar 11, 2024

github-actions bot commented Mar 11, 2024

github-actions bot commented Mar 11, 2024

jashapiro commented Mar 11, 2024

jashapiro commented Mar 11, 2024

sjspielman commented Mar 11, 2024

jashapiro left a comment

github-actions bot commented Mar 12, 2024

jashapiro Mar 12, 2024

jashapiro left a comment

jashapiro Mar 12, 2024

jashapiro Mar 12, 2024

sjspielman Mar 12, 2024

jashapiro Mar 12, 2024

jashapiro Mar 12, 2024

sjspielman Mar 12, 2024

sjspielman Mar 12, 2024

sjspielman Mar 12, 2024

Add spellcheck workflow #138

Add spellcheck workflow #138

Conversation

sjspielman commented Mar 11, 2024

Purpose

Temporary trigger of PRs to main

cron job and manual dispatch

Issue Addressed

Any comments, concerns, or questions important for reviewers

sjspielman commented Mar 11, 2024

sjspielman commented Mar 11, 2024

github-actions bot commented Mar 11, 2024

github-actions bot commented Mar 11, 2024

jashapiro commented Mar 11, 2024

jashapiro commented Mar 11, 2024

sjspielman commented Mar 11, 2024

jashapiro left a comment

Choose a reason for hiding this comment

github-actions bot commented Mar 12, 2024

Choose a reason for hiding this comment

jashapiro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Temporary trigger of PRs to `main`