Add Job to automatically sort the dictionary file if desired.

[acoffman]

This introduces a new input boolean: sort_dictionary which defaults to false. (I figured it would be best if we didn't start committing to peoples' repositories automatically without them opting into the behavior.)

If the user sets sort_dictionary to true, another job will run when check spelling is run. The job will

• check out the PR branch
• ensure that the provided GH_PAT has write permissions to the repo in question
• sort the dictionary file into a temporary file and check if they differ
• if so, it deletes the old dictionary file and moves the new one into place, then commits and pushes to the PR branch.

As best as I can tell, it appears that the gh_pat token was not being used the report maker action previously. The way it is currently being invoked (see here) passes the literal string secrets.GH_PAT into report-maker. Changing it to ${{ secrets.GH_PAT }} to get the value directly throws an error because you cannot pass a secret in via an input like that, it needs to be passed in explicitly as a secret . You can see an updated version that functions as expected in the course I've been using the test this here.

If that looks correct to you, I can also create a PR back the OTTR_Template repo with the change. I have a test course repo with a PR demonstrating to new behavior here

I can also go ahead and update the README to document this new option if you're okay with this approach in general.

closes jhudsl/OTTR_Template#233

[cansavvy]

@acoffman Thanks for doing this! This all seems reasonable on a first glance. Can you point me to where/how you tested this so I can look into those logs?

[acoffman]

@cansavvy No problem! I have a repo here cloned from the OTTR Template where I am pointing it to this branch and have an open PR that updates the dictionary: acoffman/test-course#7 (This action run specifically: https://github.com/acoffman/test-course/actions/runs/12381955138/job/34561616152 if that's helpful)

[cansavvy]

Thanks! This is great!

I just have some questions and ideas that can be implemented elsewhere but to expand on this.

[cansavvy]

Ah this is good. We should make this a function and use this elsewhere because permissions (or lack thereof) is a frequent issue for ottr users.

[cansavvy]

So no need for the token argument then?

[cansavvy]

We could add this to the docker image so this can be used everywhere