Skip to content

Conversation

@equinoy
Copy link
Contributor

@equinoy equinoy commented Apr 25, 2025

Feature: 4 Series support
This pull request introduces significant updates to the CI/CD workflows and release configuration for the Essentials Plugin project. It adds new workflows for building plugins and generating the README, removes outdated workflows for beta and release builds, and introduces a semantic release configuration for automated versioning and changelog management.

CI/CD Workflow Updates:

  • Added a new workflow .github/workflows/EssentialsPlugins-builds-caller.yml to build Essentials Plugins for both 3-Series and 4-Series devices. This workflow integrates with reusable templates and uses outputs from a version-checking job to determine whether to proceed with builds.
  • Removed the outdated beta build workflow .github/workflows/essentialsplugins-betabuilds-caller.yml. This workflow is no longer needed due to the new build process.
  • Removed the outdated release build workflow .github/workflows/essentialsplugins-releasebuilds-caller.yml, which has been replaced by the new semantic release setup.
  • Added a new workflow .github/workflows/essentialsplugins-updatereadme-caller.yml to automatically generate and update the README file, excluding changes from the robot-docs branch.

Release Configuration:

  • Introduced a new .releaserc.json file to configure semantic release. This includes plugins for analyzing commits, generating release notes, updating the changelog, and executing custom release commands. It also defines branch-specific release rules for main, release, and feature branches.

Documentation:

  • Minor formatting adjustment in README.md to remove an unnecessary blank line.

@equinoy equinoy requested review from Copilot and jkdevito April 25, 2025 17:56
@equinoy equinoy self-assigned this Apr 25, 2025
Copy link
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 support for 4 Series devices by updating CI/CD workflows, automating the README generation, and refining release configuration.

  • Removes an unnecessary blank line in README.md
  • Introduces a new workflow to auto-update the README
  • Adds a new build workflow that supports both 3-Series and 4-Series devices

Reviewed Changes

Copilot reviewed 35 out of 38 changed files in this pull request and generated no comments.

File Description
README.md Removes extra blank line for formatting consistency
.github/workflows/essentialsplugins-updatereadme-caller.yml Adds workflow to automatically generate and update the README
.github/workflows/EssentialsPlugins-builds-caller.yml Introduces build jobs for 3-Series and 4-Series devices using reusable workflow templates
Files not reviewed (3)
  • .github/workflows/essentialsplugins-betabuilds-caller.yml: Language not supported
  • .github/workflows/essentialsplugins-releasebuilds-caller.yml: Language not supported
  • .releaserc.json: Language not supported

@jonnyarndt
Copy link
Contributor

jonnyarndt commented Apr 25, 2025

@equinoy & @jkdevito, is this PR removing the existing 3-series compatibility (the current 3Series SLN in the root directory is not viable)? If only 4-series, should the 3-series files be removed? @equinoy, the minimumEssentialsVersion requirement within the Factory is set as 2.4.6, but the 4-series SLN dependency is at 2.4.4.

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.

5 participants