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

Retext-spell needs to run on PRs #25937

Closed
marcysutton opened this issue Jul 21, 2020 · 3 comments
Closed

Retext-spell needs to run on PRs #25937

marcysutton opened this issue Jul 21, 2020 · 3 comments
Labels
help wanted Issue with a clear description that the community can help with. type: bug An issue or pull request relating to a bug in Gatsby type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@marcysutton
Copy link
Contributor

marcysutton commented Jul 21, 2020

Description

With #24372, the retext-spell bot checks spelling against a dictionary.txt file. It's working okay, except that it doesn't run on PRs. This results in changes going in without a notification of issues with the dictionary, causing builds on master to fail.

Contributors and team members should know whether a PR actually passes the linter, rather than guessing or causing a broken build.

Motivation

We need the status checks to accurately reflect the status of a PR, including spelling/dictionary issues, so we don't have to come back in and fix them after the fact (and cause a headache for other PR authors).

Steps to reproduce

Look at the checks in this PR, and see how ci/circleci: lint says "Your tests passed on CircleCI!"

A GitHub PR with passing checks

When this PR was merged to master, it broke the build: https://app.circleci.com/pipelines/github/gatsbyjs/gatsby/46391/workflows/40268339-bbd9-4ad1-a883-2c3ddc6def23/jobs/472848

CircleCI showing failing checks

Expected result

The linter should fail code at PR stage, not when merged to master. I wouldn't expect it to automatically fix issues with the dictionary, but at least warn contributors when it's failing on a branch.

Actual result

Dictionary checks don't run on PRs, so we miss linting issues. This is unsustainable.

Environment

N/A. this happens for all GitHub users.

@marcysutton marcysutton added the type: bug An issue or pull request relating to a bug in Gatsby label Jul 21, 2020
@gatsbot gatsbot bot added the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label Jul 21, 2020
@marcysutton marcysutton added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Jul 21, 2020
@wardpeet wardpeet added help wanted Issue with a clear description that the community can help with. and removed status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer labels Jul 22, 2020
@github-actions
Copy link

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 30 days of inactivity. It’s been at least 20 days since the last update here.
If we missed this issue or if you want to keep it open, please reply here. You can also add the label "not stale" to keep this issue open!
As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contribute for more information about opening PRs, triaging issues, and contributing!

Thanks for being a part of the Gatsby community! 💪💜

@github-actions github-actions bot added the stale? Issue that may be closed soon due to the original author not responding any more. label Aug 11, 2020
@jaebradley
Copy link

jaebradley commented Sep 14, 2020

@marcysutton is this still an issue?

Here's a test commit on a PR (e627dd4) where it seems like documentation linting is working on a per PR-basis

I wonder if the reason why the lint:docs command successfully completed on the branch was that the repository (https://github.com/mistryvatsal/gatsby) hadn't rebased before merge and was missing some essential changes/ files that had been merged into master.

For example, the repository (which doesn't seem to have been modified since the PR referenced in this issue was merged) seems to have a different .remarkrc.js file from what was on master on time of merge.

image

When I copy the .remarkrc.js configuration in the above repository, I can get documentation linting to pass even though I've introduced a docs markdown file with typos (30ba769)

Build is here: https://app.circleci.com/pipelines/github/gatsbyjs/gatsby/49230/workflows/73abd618-11da-4f70-ab26-de264f66f6e2/jobs/504345

I could totally be missing something - I mostly stumbled upon this issue because I've been looking to contribute and this seemed like a good issue to help with; unfortunately, I am unsure if this is still a problem, but if it is, I'm happy to help out if I can!

@github-actions github-actions bot removed the stale? Issue that may be closed soon due to the original author not responding any more. label Sep 15, 2020
@LekoArts
Copy link
Contributor

Yeah, that seems correct that it works now and the PR in question had an outdated fork of the repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Issue with a clear description that the community can help with. type: bug An issue or pull request relating to a bug in Gatsby type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

No branches or pull requests

4 participants