Open PLC Editor - IDE

Running a preview version

In order to run the development version, clone the repository, and install dependencies via npm, you need network access.

You'll need the following tools:

• Git
• NodeJS, version >=20 <24

Step by step

• Clone the repository locally and go to the project folder.

git clone https://github.com/Autonomy-Logic/openplc-editor.git

cd openplc-editor

• Install the dependencies

npm install

• Run the development script

npm run dev

Releasing a New Version

The project uses GitHub Actions to automatically build and release new versions for all supported platforms (macOS, Windows, and Linux) in both x64 and ARM64 architectures.

Creating a Release

To create a new release, simply create and push a new tag with the version number:

git tag v4.2.0
git push origin v4.2.0

This will automatically: 1. Build the application for all platforms (macOS, Windows, Linux) and architectures (x64, ARM64) 2. Sign and notarize the macOS builds 3. Create a GitHub Release with all artifacts attached 4. Generate release notes based on commits since the last release

Version Naming

• Use semantic versioning: vMAJOR.MINOR.PATCH (e.g., v4.2.0)
• For pre-releases, add a suffix: v4.2.0-beta, v4.2.0-alpha, or v4.2.0-rc1
• Pre-release tags will be marked as pre-releases on GitHub

Manual Workflow Trigger

You can also trigger the build workflow manually from the GitHub Actions tab without creating a release. This is useful for testing builds:

1. Go to Actions > Build and Release
2. Click "Run workflow"
3. Optionally specify a version number
4. Click "Run workflow"

Note: Manual triggers will build all artifacts but won't create a GitHub Release (releases are only created when pushing a tag).

Documentation

Please go to the repository wiki page to get instruction about the project.

Project Management

Go to project management page to see the current state of the project.

Issues

Go to issues page to view the current state of issues in the project.