gravitational / docs

Source code backing goteleport.com/docs
https://goteleport.com/docs
Apache License 2.0
11 stars 13 forks source link

Fix the "Lint code base" workflow and package.json #374

Closed ptgott closed 1 year ago

ptgott commented 1 year ago

Fix the "Lint code base" workflow and package.json

This change cleans up the "Lint code base" GitHub Actions workflow in order to ensure that it works as expected:

This change also fixes the "engines" key in package.json. This was previously given as "engine", which is not a valid package.json key. Also constrains the Node version to minor/patch releases of v18.

vercel[bot] commented 1 year ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 15, 2023 9:31pm
ptgott commented 1 year ago

Worth noting that the PR that ended up breaking Vercel deploys (https://github.com/gravitational/docs/pull/367) actually passed the Vercel deployment step. I'm still not sure why this is. Hopefully adding yarn update-and-build to the GHA workflow for gravitational/docs PRs will prevent stuff like this.

I've confirmed that cherry-picking #367 on to this branch fails the linter and yarn typecheck locally.

ptgott commented 1 year ago

@avatus Currently the base.yml job runs on push. If we want it to build the docs site (which takes >10mins), should I change that to pull_request and push with the main branch so the GHA runner doesn't run as much?

avatus commented 1 year ago

I think on pr and push sounds fine to me. Wow, how did we miss the engines thing lol. Thanks!

ptgott commented 1 year ago

@avatus Thanks! Just tweaked the on settings