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

Track changed docs #121

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Track changed docs #121

wants to merge 3 commits into from

Conversation

fabianrbz
Copy link
Collaborator

Add tool that check for changes in files in the docs repo that are used as sources for dev site pages.

Example config file

app/_gateway_entities/consumer.md:
  - app/_src/gateway/key-concepts/consumers.md

app/_gateway_entities/service.md:
  - app/_src/gateway/key-concepts/services.md
  - app/_src/gateway/get-started/index.md

How it works

  1. Read ./config/sources.yml to build a mapping of the files in the docs repo that serve as the source for dev site pages.
  2. Check for changes made to the source files in the docs repository (specify the relative path to the docs repository using the environment variable DOCS_PATH) over the past DAYS_TO_CHECK_FOR_DOCS_CHANGES days.
  3. For each dev site page specified in ./config/sources.yml, it outputs:
    • The file path corresponding to each source in the docs repository.
    • For each source, a link to the pull requests (PRs) that modified it within the specified date range.

How to run it

In the current directory:

npm ci
DOCS_PATH='<relative path to docs repo>' node index.js

Copy link

netlify bot commented Oct 16, 2024

Deploy Preview for kongdeveloper ready!

Name Link
🔨 Latest commit 79bf8ad
🔍 Latest deploy log https://app.netlify.com/sites/kongdeveloper/deploys/670fb359c5ca4b0008f380b4
😎 Deploy Preview https://deploy-preview-121--kongdeveloper.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@fabianrbz fabianrbz marked this pull request as ready for review October 17, 2024 07:11
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.

1 participant