rsnext/.github/actions/validate-docs-links
lijianan 9ce18c4d5f
chore: update Copyright time from 2023 to 2024 (#60071)
<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation

- Run `pnpm prettier-fix` to fix formatting issues before opening the
PR.
- Read the Docs Contribution Guide to ensure your contribution follows
the docs guidelines:
https://nextjs.org/docs/community/contribution-guide

### Adding or Updating Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md


## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

### What?

### Why?

### How?

Closes NEXT-
Fixes #

-->
2024-01-02 11:06:02 -08:00
..
dist chore: update Copyright time from 2023 to 2024 (#60071) 2024-01-02 11:06:02 -08:00
src Improve performance of String.prototype.split uses (#56746) 2023-10-19 00:25:15 +00:00
package.json ci: report daily turbo integration test results from this repo (#58965) 2023-12-04 16:18:42 +01:00
README.MD Revert "[Docs] Fix validator action breaking when PRs originate from … (#51674) 2023-06-22 19:50:14 +00:00
tsconfig.json Migrate validate links script from next-site and setup GitHub action (#51365) 2023-06-20 13:19:06 +00:00
types.d.ts Migrate validate links script from next-site and setup GitHub action (#51365) 2023-06-20 13:19:06 +00:00

GitHub Action for Validating Documentation Links

This action ensures that internal links in .mdx files in the /docs/ directory are valid. It runs on every pull request that includes changes to these files.

The action is triggered by the workflow defined in .github/workflows/validate-docs-links.yml.

Usage

This action is written in TypeScript and compiled locally before being pushed to GitHub.

To make changes:

  • Edit the src/index.ts file.
  • Navigate to the script folder cd .github/actions/validate-docs-links
  • Run npm install to install dependencies.
  • Run npm run build to compile code. This will create an updated lib/index.js.
  • Commit and push changes to GitHub.