Add check spelling

[jsoref]

closes #133

[baum]

@jsoref thank you for the awesome PR! Please sign off the commit, see here.
@epuertat The new workflow is green in the fork, WDYT?

[epuertat]

Thank you very much @jsoref for your quick response here! I left a few comments over there. Plz let me know your thoughts! Thanks!

[jsoref]

I'm going to make a push that replaces the tags with shas and switches from checkout: true to using a step w/ uses: actions/checkout@v3

[epuertat]

Thanks a lot @jsoref for the thorough work here! LGTM! I'll add a "couple" of folks to review this too.

[gbregman]

LGTM

[caroav]

@baum please review too.

[baum]

@jsoref Is it possible to disable automatic content changes and instead opt for a spell-checking mechanism that highlights errors, requiring human intervention for any necessary corrections?

[jsoref]

@baum: check-spelling in this repository won't automatically make content changes -- if actions are enabled in forks, it will suggest them there -- #177 (comment) , but even then it doesn't automatically apply things, it merely suggests them (and its suggestions aren't fixes for typos, it merely assumes that the words people have added are intentional).

That said, if that is too much, I can certainly remove:

ceph-nvmeof/.github/workflows/spelling.yml

Line 105 in cded756

experimental_apply_changes_via_bot: ${{ github.repository_owner != 'ceph' && 1 }}

and

ceph-nvmeof/.github/workflows/spelling.yml

Lines 121 to 145 in cded756

	update:
	name: Update PR
	permissions:
	contents: write
	pull-requests: write
	actions: read
	runs-on: ubuntu-latest
	if: ${{
	github.repository_owner != 'ceph' &&
	github.event_name == 'issue_comment' &&
	github.event.issue.pull_request &&
	contains(github.event.comment.body, '@check-spelling-bot apply')
	}}
	concurrency:
	group: spelling-update-${{ github.event.issue.number }}
	cancel-in-progress: false
	steps:
	- name: Checkout code
	uses: actions/checkout@v3
	- name: apply spelling updates
	uses: check-spelling/check-spelling@d7cd2973c513e84354f9d6cf50a6417a628a78ce
	with:
	experimental_apply_changes_via_bot: 1
	ssh_key: "${{ secrets.CHECK_SPELLING }}"

Happy to talk this over on Slack during the week if that's helpful.

[baum]

@baum: check-spelling in this repository won't automatically make content changes -- if actions are enabled in forks, it will suggest them there -- #177 (comment) , but even then it doesn't automatically apply things, it merely suggests them (and its suggestions aren't fixes for typos, it merely assumes that the words people have added are intentional).

That said, if that is too much, I can certainly remove:

ceph-nvmeof/.github/workflows/spelling.yml

Line 105 in cded756

experimental_apply_changes_via_bot: ${{ github.repository_owner != 'ceph' && 1 }}

and

ceph-nvmeof/.github/workflows/spelling.yml

Lines 121 to 145 in cded756

	update:
	name: Update PR
	permissions:
	contents: write
	pull-requests: write
	actions: read
	runs-on: ubuntu-latest
	if: ${{
	github.repository_owner != 'ceph' &&
	github.event_name == 'issue_comment' &&
	github.event.issue.pull_request &&
	contains(github.event.comment.body, '@check-spelling-bot apply')
	}}
	concurrency:
	group: spelling-update-${{ github.event.issue.number }}
	cancel-in-progress: false
	steps:
	- name: Checkout code
	uses: actions/checkout@v3
	- name: apply spelling updates
	uses: check-spelling/check-spelling@d7cd2973c513e84354f9d6cf50a6417a628a78ce
	with:
	experimental_apply_changes_via_bot: 1
	ssh_key: "${{ secrets.CHECK_SPELLING }}"

Happy to talk this over on Slack during the week if that's helpful.

@jsoref Thank you for explanation 👍

[jsoref]

This is ready to go. I'll start watching the repo for a month or so and I'm available by @jsoref or on slack if people run into anything.

[baum]

@jsoref please merge. thank you!