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.

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

Spelling.yml add #311

Closed
wants to merge 6 commits into from
Closed

Spelling.yml add #311

wants to merge 6 commits into from

Conversation

devarsh10
Copy link

@devarsh10 devarsh10 commented Oct 26, 2023

"Fixes #82 "
"I have added two files,

  1. Spelling.yml which will run when a new commit is made & check for spelling mistakes.
  2. Also added the spell-test.txt, for verification purpose."

@kserve-oss-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: devarsh10
To complete the pull request process, please assign alexagriffith after the PR has been reviewed.
You can assign the PR to them by writing /assign @alexagriffith in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@netlify
Copy link

netlify bot commented Oct 26, 2023

Deploy Preview for elastic-nobel-0aef7a ready!

Name Link
🔨 Latest commit 89cc0f0
🔍 Latest deploy log https://app.netlify.com/sites/elastic-nobel-0aef7a/deploys/653bb5fe9491df00082ffddb
😎 Deploy Preview https://deploy-preview-311--elastic-nobel-0aef7a.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@devarsh10 devarsh10 changed the title Spelling.yaml and Spell-test.txt file add Spelling.yml add Oct 26, 2023
- 'opened'
- 'reopened'
- 'synchronize'
issue_comment:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe we don't need to run spell check for issue comments.

- "**"
tags-ignore:
- "**"
pull_request_target:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can just use the pull_request trigger like here

internal_state_directory: ${{ steps.spelling.outputs.internal_state_directory }}
docker_container: ${{ steps.spelling.outputs.docker_container }}
env:
workflow_check_commit_messages: commits
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it check for spelling mistakes in commit messages too ?

env:
workflow_check_commit_messages: commits
runs-on: ubuntu-latest
if: ${{ contains(github.event_name, 'pull_request') || github.event_name == 'push' }}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need this check ?

- name: test-clean
shell: bash
run:
cp -R . ../introspected/;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need this step ?

mv ../introspected .
- name: test-merge
if: ${{ contains(github.event_name, 'pull_request') }}
uses: check-spelling/[email protected]
Copy link
Member

@sivanantha321 sivanantha321 Oct 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why do we need this action ? I believe we can remove this step.

- name: check-spelling
if: env.MERGE_FAILED != '1'
id: spelling
uses: ./
Copy link
Member

@sivanantha321 sivanantha321 Oct 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe you have to specify the action check-spelling/check-spelling@main here since the action is not defined in this repo. You can refer this workflow

- name: checkout
uses: actions/checkout@v4
- name: comment
uses: ./
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have to use check-spelling/check-spelling@main action here

- name: checkout
uses: actions/checkout@v4
- name: comment
uses: ./
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have to use check-spelling/check-spelling@main action here

name: Update PR
permissions:
contents: write
pull-requests: write
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this job correct the spelling mistakes in the PR? If yes, then I think it is best to leave it to the contributor rather than updating it here. WDYT ?

@devarsh10
Copy link
Author

Hey @sivanantha321, I would like to close this PR. Please allow me, as I had made some blunders.
Sorry for the inconvenience.

@devarsh10 devarsh10 closed this by deleting the head repository Oct 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Run spelling checks for website repo
3 participants