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

Mention libvips/sharp gotcha in setup instructions #2932

Closed
wants to merge 5 commits into from
Closed

Mention libvips/sharp gotcha in setup instructions #2932

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2caea4c
Add libvips/sharp gotcha to setup instructions
duijf Oct 18, 2021
19c00b8
Update content/docs/user-guide/contributing/docs.md
jorgeorpinel Oct 21, 2021
d569377
Add debug git calls
rogermparent Oct 22, 2021
8078570
Add fetch-depth and new version of link-check
rogermparent Oct 22, 2021
534ee86
Remove debug diffs
rogermparent Oct 22, 2021
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
4 changes: 3 additions & 1 deletion .github/workflows/link-check-deploy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ jobs:
github.event.deployment_status.state == 'success'
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
- id: build_check
uses: LouisBrunner/[email protected]
with:
Expand All @@ -21,7 +23,7 @@ jobs:
status: queued
- name: Run Link Check
id: check
uses: iterative/link-check.action@v0.8
uses: iterative/link-check.action@v0.9
with:
diff: true
configFile: config/link-check/config.yml
Expand Down
11 changes: 11 additions & 0 deletions content/docs/user-guide/contributing/docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,17 @@ Launch the server locally with:
$ yarn develop
```

> ⚠️ Do you get an error from `gatsby-plugin-manifest` about unsupported image
> formats? You may be running into
> [this issue](https://github.com/gatsbyjs/gatsby/issues/20698). You can fix it
> by reinstalling `node_modules` with a flag that forces `sharp` to ignore your
> globally installed `libvips`:
>
> ```dvc
> $ rm -r node_modules
> $ SHARP_IGNORE_GLOBAL_LIBVIPS=true yarn
> ```
Comment on lines +89 to +97
Copy link
Contributor

@jorgeorpinel jorgeorpinel Oct 21, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

If we must have this, let's keep it very very short 🙂

Suggested change
> formats? You may be running into
> [this issue](https://github.com/gatsbyjs/gatsby/issues/20698). You can fix it
> by reinstalling `node_modules` with a flag that forces `sharp` to ignore your
> globally installed `libvips`:
>
> ```dvc
> $ rm -r node_modules
> $ SHARP_IGNORE_GLOBAL_LIBVIPS=true yarn
> ```
> formats? You may be running into
> [this issue](https://github.com/gatsbyjs/gatsby/issues/20698#issuecomment-576353427).

☝️ direct link to the solution

Copy link
Contributor

Choose a reason for hiding this comment

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

In fact I'd move this note after the paragraph below.


This will start the server on the default port, `8000`. Visit
`http://localhost:8000/` and navigate to the page in question. This will also
enable the pre-commit Git hook that will be formatting and linting your code and
Expand Down