Skip to content

FireFist-Redhawk/labview-icon-editor

 
 

Repository files navigation

LabVIEW Icon Editor

Build VI Package Latest Release Discord


🧭 Table of Contents (Users)

🧑‍💻 Table of Contents (Collaborators)


📌 Overview

The LabVIEW Icon Editor is an open-source, MIT-licensed project that releases VI Packages with the latest community-driven features. When LabVIEW is built for an official release, it automatically pulls the latest version of the Icon Editor from this repo’s main branch—currently targeting LabVIEW 2026 Q1.

This means that your contributions—whether features, fixes, or docs—can ship with official LabVIEW distributions.

  • 🛠 Built entirely in G
  • ⚙️ GitHub Actions orchestrate PowerShell-based CI workflows for testing, packaging, and publishing .vip artifacts
  • 🔁 This project pioneered CI/CD pipelines, documentation, and foundational infrastructure that will eventually migrate to a centralized dependency repository so that it can expand along with other concepts (e.g. lvenv)

NI’s Open Source Program encourages community collaboration to evolve and improve this tooling that streamlines the way the LabVIEW community tests NI-governed features.


📦 How to Install

Prerequisites:
• LabVIEW 2021 SP1 or newer

  1. Download the latest .vip file from the releases page.
  2. Open VIPM in Administrator mode.
  3. Install by double-clicking the .vip file or opening it via File ▶ Open Package in VIPM.
  4. Verify the installation by creating a new VI and opening the Icon Editor.

🧩 Key Components

  1. Source Files

    • VI-based.
  2. PowerShell Automation

    • Built on G-CLI
    • Supports repeatable builds, releases, and CI tasks
    • Easy to use in local or GitHub-hosted runners
  3. CI/CD Workflows


🚀 Getting Started & Contributing

We welcome both code and non-code contributions—from bug fixes and performance improvements to documentation or testing.

  • 📑 CLA Required – External contributors must sign a Contributor License Agreement before we can merge your pull request.
  • 🧭 Steering Committee – A mix of members of LabVIEW R&D and community volunteers who guide roadmap and merge authority.
  • 🔄 Issues & Experiments – Look for issues labeled “Workflow: Open to contribution”.
  • 🧪 Long-Lived Features – For experimental branches, see EXPERIMENTS.md

More contribution info is in CONTRIBUTING.md.


🌱 Feature & Experiment Workflows

Standard Feature Workflow

  1. Discuss or Propose an Issue

  2. Assignment

    • Once approved by LabVIEW R&D, issue is labeled Workflow: Open to contribution
    • A volunteer comments on the issue in order to get assigned
    • NI Maintainer creates a feature branch and assigns the issue
  3. Branch Setup

    • Fork + clone the repo
    • Checkout the feature branch and implement your changes
  4. Build Method

  5. Submit PR

    • CI will build and publish a testable .vip
    • Reviewers verify and collaborate with you until it’s ready
  6. Merge & Release

    • Merges go to develop, then to main during the next release cycle

Experimental Workflow

  • Used for large or multi-week features
  • Docker VI Analyzer & CodeQL run automatically
  • Manual approval required for .vip publishing (approve-experiment event)
  • Sub-branches for alpha/beta/RC are optional

More info in EXPERIMENTS.md


📚 Documentation

Explore the /docs folder for technical references:


📄 License & CLA

  • MIT License: LICENSE
  • Contributor License Agreement: Required before we can merge your contributions

By contributing, you grant NI the right to distribute your changes with LabVIEW.


💬 Contact & Discord


🙏 Thanks for Contributing!

Your ideas, tests, and code shape the Icon Editor experience across LabVIEW 2021–2026 and beyond.

About

Source for LabVIEW's icon editor

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • LabVIEW 62.7%
  • HTML 33.7%
  • PowerShell 3.6%