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

Add CI to automate heavy PR load #3374

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

vishwamartur
Copy link

Related to #1365

Implement CI to automate heavy PR load using awesome-lint.

  • .github/workflows/main.yml
    • Add a step to run awesome-lint on readme.md after the checkout step.
  • .github/workflows/repo_linter.sh
    • Add npx awesome-lint command to lint the repository after cloning.
  • readme.md
    • Mention the usage of awesome-lint for CI in the introduction.
    • Add a section about awesome-lint in the "Contribution guide".
  • contributing.md
    • Add instructions for running awesome-lint before submitting a PR.
    • Mention the requirement to pass awesome-lint in the PR guidelines.

Related to sindresorhus#1365

Implement CI to automate heavy PR load using `awesome-lint`.

* **.github/workflows/main.yml**
  - Add a step to run `awesome-lint` on `readme.md` after the checkout step.
* **.github/workflows/repo_linter.sh**
  - Add `npx awesome-lint` command to lint the repository after cloning.
* **readme.md**
  - Mention the usage of `awesome-lint` for CI in the introduction.
  - Add a section about `awesome-lint` in the "Contribution guide".
* **contributing.md**
  - Add instructions for running `awesome-lint` before submitting a PR.
  - Mention the requirement to pass `awesome-lint` in the PR guidelines.
Copy link

@ankddev ankddev left a comment

Choose a reason for hiding this comment

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

Some thoughts by me.

Comment on lines 20 to +25
git clone "$REPO_TO_LINT" .
npx awesome-lint
fi

# Lint the repository using awesome-lint
npx awesome-lint
Copy link

Choose a reason for hiding this comment

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

But it already run awesome-lint in previous step, so I don't think that this is reliable change.

Comment on lines +15 to +16
- name: Run awesome-lint on readme.md
run: npx awesome-lint readme.md
Copy link

Choose a reason for hiding this comment

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

It runs repo_linter.sh so additional step with linting is unneded.

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.

4 participants