Skip to content

ci: improve sassdoc build and update theme #15844

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

Open
wants to merge 5 commits into
base: 19.2.x
Choose a base branch
from

Conversation

simeonoff
Copy link
Collaborator

@simeonoff simeonoff commented May 22, 2025

This PR is a result of a refactoring done for the Sassdoc theme. It aims to improve the generated Sass documentation and replaces gulp in the process.

Additional information (check all that apply):

  • Bug fix
  • New functionality
  • Documentation
  • Demos
  • CI/CD

Checklist:

  • All relevant tags have been applied to this PR
  • This PR includes unit tests covering all the new code (test guidelines)
  • This PR includes API docs for newly added methods/properties (api docs guidelines)
  • This PR includes feature/README.MD updates for the feature docs
  • This PR includes general feature table updates in the root README.MD
  • This PR includes CHANGELOG.MD updates for newly added functionality
  • This PR contains breaking changes
  • This PR includes ng update migrations for the breaking changes (migrations guidelines)
  • This PR includes behavioral changes and the feature specification has been updated with them

simeonoff added 2 commits May 22, 2025 09:15
- Replace legacy SassDoc build logic in gulpfile.js with new
scripts/build-sassdoc.mjs
- Update all npm scripts to use build-sassdoc.mjs
- Upgrade igniteui-sassdoc-theme to ^2.0.0-beta.1 in dependencies and
lockfile
- Add scripts/logger.mjs for consistent logging
- Update GitHub Actions workflow to use unified build:docs script
Copy link
Contributor

@Copilot 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 refactors the Sassdoc theme integration by replacing the old Gulp-based tasks with a Node.js–based build script, while also updating dependencies and CI workflows.

  • Replaces Gulp tasks with a new Node.js script (build-sassdoc.mjs) for building Sass documentation.
  • Updates package.json build scripts and dependency versions for Sassdoc and its plugins.
  • Adjusts the CI workflow to use the unified build:docs command.

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
scripts/logger.mjs Introduces minimalist logging functions using colored and timestamped output.
scripts/build-sassdoc.mjs Implements a Node.js approach to scan, parse, and generate Sass documentation.
package.json Updates build commands and bumps dependency versions to beta/alpha releases.
gulpfile.js Removes obsolete Sassdoc Gulp tasks in favor of the new Node-based build.
.github/workflows/nodejs.yml Modifies build commands in CI to use the unified docs build script.

@simeonoff simeonoff marked this pull request as draft May 22, 2025 06:36
@simeonoff simeonoff changed the title Simeonoff/docs ci ci: improve sassdoc build and update theme May 22, 2025
@simeonoff simeonoff marked this pull request as ready for review May 22, 2025 10:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants