Repository navigation
docs: add 4.17.0 release documentation #223
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,166 +1,36 @@ | ||
| name: Check Spelling | ||
|
|
||
| # Comment management is handled through a secondary job, for details see: | ||
| # https://github.com/check-spelling/check-spelling/wiki/Feature%3A-Restricted-Permissions | ||
| # | ||
| # `jobs.comment-push` runs when a push is made to a repository and the `jobs.spelling` job needs to make a comment | ||
| # (in odd cases, it might actually run just to collapse a comment, but that's fairly rare) | ||
| # it needs `contents: write` in order to add a comment. | ||
| # | ||
| # `jobs.comment-pr` runs when a pull_request is made to a repository and the `jobs.spelling` job needs to make a comment | ||
| # or collapse a comment (in the case where it had previously made a comment and now no longer needs to show a comment) | ||
| # it needs `pull-requests: write` in order to manipulate those comments. | ||
|
|
||
| # Updating pull request branches is managed via comment handling. | ||
| # For details, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Update-expect-list | ||
| # | ||
| # These elements work together to make it happen: | ||
| # | ||
| # `on.issue_comment` | ||
| # This event listens to comments by users asking to update the metadata. | ||
| # | ||
| # `jobs.update` | ||
| # This job runs in response to an issue_comment and will push a new commit | ||
| # to update the spelling metadata. | ||
| # | ||
| # `with.experimental_apply_changes_via_bot` | ||
| # Tells the action to support and generate messages that enable it | ||
| # to make a commit to update the spelling metadata. | ||
| # | ||
| # `with.ssh_key` | ||
| # In order to trigger workflows when the commit is made, you can provide a | ||
| # secret (typically, a write-enabled github deploy key). | ||
| # | ||
| # For background, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Update-with-deploy-key | ||
|
|
||
| # Sarif reporting | ||
| # | ||
| # Access to Sarif reports is generally restricted (by GitHub) to members of the repository. | ||
| # | ||
| # Requires enabling `security-events: write` | ||
| # and configuring the action with `use_sarif: 1` | ||
| # | ||
| # For information on the feature, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Sarif-output | ||
|
|
||
| # Minimal workflow structure: | ||
| # | ||
| # on: | ||
| # push: | ||
| # ... | ||
| # pull_request_target: | ||
| # ... | ||
| # jobs: | ||
| # # you only want the spelling job, all others should be omitted | ||
| # spelling: | ||
| # # remove `security-events: write` and `use_sarif: 1` | ||
| # # remove `experimental_apply_changes_via_bot: 1` | ||
| # ... otherwise adjust the `with:` as you wish | ||
| # This workflow is intentionally manual-only so spelling does not block pushes | ||
| # or pull requests. | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - "**" | ||
| tags-ignore: | ||
| - "**" | ||
| pull_request_target: | ||
| branches: | ||
| - "**" | ||
| types: | ||
| - 'opened' | ||
| - 'reopened' | ||
| - 'synchronize' | ||
| issue_comment: | ||
| types: | ||
| - 'created' | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| spelling: | ||
| name: Check Spelling | ||
| permissions: | ||
| contents: read | ||
| pull-requests: read | ||
| actions: read | ||
| security-events: write | ||
| outputs: | ||
| followup: ${{ steps.spelling.outputs.followup }} | ||
| runs-on: ubuntu-latest | ||
| if: ${{ contains(github.event_name, 'pull_request') || github.event_name == 'push' }} | ||
| concurrency: | ||
| group: spelling-${{ github.event.pull_request.number || github.ref }} | ||
| group: spelling-${{ github.ref }} | ||
| # note: If you use only_check_changed_files, you do not want cancel-in-progress | ||
| cancel-in-progress: true | ||
| steps: | ||
| - name: check-spelling | ||
| id: spelling | ||
| uses: check-spelling/check-spelling@main | ||
| with: | ||
| suppress_push_for_open_pull_request: ${{ github.actor != 'dependabot[bot]' && 1 }} | ||
| checkout: true | ||
| check_file_names: 0 | ||
| spell_check_this: check-spelling/spell-check-this@prerelease | ||
| post_comment: 0 | ||
| use_magic_file: 0 | ||
| report-timing: 1 | ||
| warnings: bad-regex,binary-file,deprecated-feature,large-file,limited-references,no-newline-at-eof,noisy-file,non-alpha-in-dictionary,token-is-substring,unexpected-line-ending,whitespace-in-dictionary,minified-file,unsupported-configuration,no-files-to-check | ||
| experimental_apply_changes_via_bot: 1 | ||
| use_sarif: ${{ (!github.event.pull_request || (github.event.pull_request.head.repo.full_name == github.repository)) && 1 }} | ||
| use_sarif: 1 | ||
| extra_dictionary_limit: 20 | ||
| extra_dictionaries: | ||
| cspell:software-terms/dict/softwareTerms.txt | ||
|
|
||
| comment-push: | ||
| name: Report (Push) | ||
| # If your workflow isn't running on push, you can remove this job | ||
| runs-on: ubuntu-latest | ||
| needs: spelling | ||
| permissions: | ||
| contents: write | ||
| if: (success() || failure()) && needs.spelling.outputs.followup && github.event_name == 'push' | ||
| steps: | ||
| - name: comment | ||
| uses: check-spelling/check-spelling@main | ||
| with: | ||
| checkout: true | ||
| spell_check_this: check-spelling/spell-check-this@prerelease | ||
| task: ${{ needs.spelling.outputs.followup }} | ||
|
|
||
| comment-pr: | ||
| name: Report (PR) | ||
| # If you workflow isn't running on pull_request*, you can remove this job | ||
| runs-on: ubuntu-latest | ||
| needs: spelling | ||
| permissions: | ||
| contents: read | ||
| pull-requests: write | ||
| if: (success() || failure()) && needs.spelling.outputs.followup && contains(github.event_name, 'pull_request') | ||
| steps: | ||
| - name: comment | ||
| uses: check-spelling/check-spelling@main | ||
| with: | ||
| checkout: true | ||
| spell_check_this: check-spelling/spell-check-this@prerelease | ||
| task: ${{ needs.spelling.outputs.followup }} | ||
| experimental_apply_changes_via_bot: 1 | ||
|
|
||
| update: | ||
| name: Update PR | ||
| permissions: | ||
| contents: write | ||
| pull-requests: write | ||
| actions: read | ||
| runs-on: ubuntu-latest | ||
| if: ${{ | ||
| 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: apply spelling updates | ||
| uses: check-spelling/check-spelling@main | ||
| with: | ||
| experimental_apply_changes_via_bot: 1 | ||
| checkout: true | ||
| ssh_key: "${{ secrets.CHECK_SPELLING }}" | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.