Skip to content

script: Add script to update docs npm deps#1376

Merged
brianmcgillion merged 1 commit intotiiuae:mainfrom
brianmcgillion:update-docs-script
Sep 9, 2025
Merged

script: Add script to update docs npm deps#1376
brianmcgillion merged 1 commit intotiiuae:mainfrom
brianmcgillion:update-docs-script

Conversation

@brianmcgillion
Copy link
Copy Markdown
Collaborator

automate the process of updating the npm dependencies

Description of Changes

Type of Change

  • New Feature
  • Bug Fix
  • Improvement / Refactor

Related Issues / Tickets

Checklist

  • Clear summary in PR description
  • Detailed and meaningful commit message(s)
  • Commits are logically organized and squashed if appropriate
  • Contribution guidelines followed
  • Ghaf documentation updated with the commit - https://tiiuae.github.io/ghaf/
  • Author has run make-checks and it passes
  • All automatic GitHub Action checks pass - see actions
  • Author has added reviewers and removed PR draft status

Testing Instructions

Applicable Targets

  • Orin AGX aarch64
  • Orin NX aarch64
  • Lenovo X1 x86_64
  • Dell Latitude x86_64
  • System 76 x86_64

Installation Method

  • Requires full re-installation
  • Can be updated with nixos-rebuild ... switch
  • Other:

Test Steps To Verify:

  1. ...

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds a new script to automate the process of updating npm dependencies for the Ghaf documentation. The script handles the complete workflow from updating packages to preparing a branch for a pull request.

Key changes:

  • Creates a new update-docs-depends package that automates npm dependency updates
  • Integrates the script into the development environment for easy access
  • Provides a complete workflow including dependency updates, hash generation, and branch preparation

Reviewed Changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 3 comments.

File Description
packages/pkgs-by-name/update-docs-depends/package.nix New script package that automates npm dependency updates for docs
packages/own-pkgs-overlay.nix Adds the new update-docs-depends package to the overlay
nix/devshell.nix Integrates the script into the development shell with a convenient command

automate the process of updating the npm dependencies

Signed-off-by: Brian McGillion <bmg.avoin@gmail.com>
@brianmcgillion brianmcgillion marked this pull request as ready for review September 9, 2025 18:27
@brianmcgillion brianmcgillion merged commit 5b68450 into tiiuae:main Sep 9, 2025
27 of 28 checks passed
@brianmcgillion brianmcgillion deleted the update-docs-script branch September 9, 2025 18:36
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.

2 participants