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.

Sign up for GitHub

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

ci: enable lint comments in pull requests #2910

Merged
merged 6 commits into from
Aug 27, 2024
Merged

ci: enable lint comments in pull requests #2910

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c677c9a
docs: remove version specific link
alexplischke Aug 27, 2024
0d9876a
docs: remove yarn
alexplischke Aug 27, 2024
17aa9a7
ci: enable lint checks in diffs
alexplischke Aug 27, 2024
3b4bfd2
docs: convert to link
alexplischke Aug 27, 2024
0365087
try PR comments instead
alexplischke Aug 27, 2024
aecca72
docs: lint
alexplischke Aug 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/workflows/vale-linter.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ on: [pull_request]

jobs:
vale:
name: runner / vale
runs-on: ubuntu-latest
steps:
- name: Checkout
Expand All @@ -18,4 +17,4 @@ jobs:
env:
# Required, set by GitHub actions automatically:
# https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Please see our Contributing Guidelines published on our site: https://docs.saucelabs.com/contributing
See our [Contributing Guidelines](https://docs.saucelabs.com/contributing).
alexplischke marked this conversation as resolved.
Show resolved Hide resolved
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@
<img src="https://app.saucelabs.com/browser-matrix/saucy-docs.svg?auth=495eb49379a16a1e211eb5d27444fa76" alt= "Sauce Labs Browser Matrix"/>
</p>

Welcome to the `sauce-docs` repository. This website contains all technical documentation about Sauce Labs and its products. This website uses [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
Welcome to the `sauce-docs` repository. This website contains all technical
documentation about Sauce Labs and its products and is built on top of
[Docusaurus](https://docusaurus.io/), a modern static website generator.

**Table of Contents**

Expand All @@ -34,8 +36,7 @@ Welcome to the `sauce-docs` repository. This website contains all technical docu
## Prerequisites

- [`git`](https://git-scm.com/downloads)
- [Node.js](https://nodejs.org/en/download/) `version >= 14.15.0` or above (which can be checked by running node -v). You can use nvm for managing multiple Node versions on a single machine installed
- [Yarn](https://yarnpkg.com/en/) `version >= 1.22.5` (which can be checked by running yarn version). Yarn is a performant package manager for JavaScript and replaces the npm client. It is not strictly necessary but highly encouraged.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Note: Removed yarn because the examples and the pipelines actually use npm. Furthermore, npm is packaged with Node.js, so no separate installation required.

- [Node.js](https://nodejs.org/en/download/) `version >= 18` or above (which can be checked by running node -v). You can use nvm for managing multiple Node versions on a single machine installed
- [Docker](https://docs.docker.com/get-docker/) (optional if you want to deploy locally via a container or to test before you deploy)

## Installation
Expand Down