UI LED (Node-RED Dashboard 2.0 Widget)

This repository contains the code base for ui-led, a third-party node for the Node-RED Dashboard 2.0.

Configuration Options

The ui-led node has the following configuration options:

General

• Name: The name of the node within the context of the Node-RED editor.
• Group: The UI Group that the LED will render inside.
• Size: The relative size of the LED with width x height

Label Styling

• Text: The label to display next to the LED.
• Placement: Which side of the LED the label will be displayed.
• Alignment: Within the space to the left/right of the LED, how the label will be aligned in that space.

LED Styling

• Shape: "Circle" or "Square"
• Show Border: Should the LED have a fixed border around the shape, emulating a physical LED.
• Show Glow: Should the LED have a glow effect.

Values

• Maps a value to a respective color. If a value is provided that it doesn't recognise, a general grey color will be used.

Release process

In this project, the Release Please is used to automatically determine the next release version based on the commit messages in the codebase.

By using the Conventional Commits, the project adheres to a standardized format for commit messages, which Release Please uses to determine whether the next release should be a major, minor, or patch release.

Components

1. The Prepare release GitHub Action workflow:

   • A Release Please action that analyzes commit messages to determine the type of release required (major, minor, patch) based on the Conventional Commits specification
   • Creates a pre-release pull request with the proposed version bump and changelog
   • Once merged, automatically updates the version number in package.json and creates a new release on GitHub with the appropriate changelog

2. The Lint Pull Request Title GitHub Action workflow:

   • A workflow that runs on pull request creation and uses the amannn/action-semantic-pull-request action to validate that pull request titles follow the Conventional Commits format
   • Together with adjusted default merge commit message, this ensures that all commits merged into the main branch adhere to the expected format, allowing Release Please to function correctly

3. The Publish Release GitHub Action workflow:

   • A workflow that runs when a new git tag in v*.*.* format is pushed, builds the package and publishes the new version to the public npm registry using the JS-DevTools/npm-publish action
   • Once package is published, the workflow updates the package version in the Node-RED Flow Library catalogue

Pull Request Title Format

The Conventional Commits preset expects pull request titles to be in the following format:

<type>(<scope>): <subject>

• Type: Describes the category of the commit. Examples include:
  • feat: A new feature (triggers a minor version bump).
  • fix: A bug fix (triggers a patch version bump).
  • perf: A code change that improves performance (triggers a patch version bump).
  • refactor: A code change that neither fixes a bug nor adds a feature (does not trigger a release unless it's accompanied by a BREAKING CHANGE).
  • docs: Documentation-only changes (does not trigger a release).
  • chore: Changes to the build process or auxiliary tools and libraries (does not trigger a release).
• Scope: An optional part that provides additional context about what was changed (e.g., module, component).
• Subject: A brief description of the changes.

Handling Breaking Changes

To indicate a breaking change, the exclamation mark ! should be used immediately after the type/scope:

• feat!:
• fix!:
• refactor!: