Skip to content

plentymarkets/plugin-hello-world

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

plentymarkets Logo

Hello World plugin

This is the Hello World plugin developed by PlentyONE.

The master branch of this repository contains a simple plugin that renders a template and registers a route under which the template is displayed. Check out the branch further_options to see more possibilities.

Requirements

This is a plugin for PlentyONE. No other plugins are required for running the plugin.

Installing

For detailed information about plugin provisioning refer to PlentyONE developers.

Install using Composer and a composer.json.

{
    "require": {
        "plentymarkets/plugin-hello-world": "dev-master"
    }
}

For available versions see the corresponding Packagist page.

For more basic information on package installation via Composer see this introduction.

Plugin documentation


⚙️ PlentyOne Plugin Build (CI Example)

This repository includes a CI pipeline example showing how to integrate Plentymarkets plugin builds into GitHub Actions.

It is a template you can adapt to your own plugin repository.


🔄 What the pipeline does

On each run (push or manual trigger), the pipeline will:

  • Request a fresh login token from PlentyONE (credentials from GitHub Secrets).
  • Trigger a Dev Mode build for the configured system and plugin set.
  • Monitor the build until completion.
  • Report success ✅ or detailed errors ❌.

🔑 Setup

1. Get system credentials

Use your Plenty credentials

  • username
  • password
  • system ID (e.g., pXXXXX)

2. Add GitHub Secrets

In your repository, go to: SettingsSecrets and variablesActions

Add the following secrets:

  • PLENTY_USERNAME → your API username
  • PLENTY_PASSWORD → your API password

3. Configure system and set IDs in workflow

Create the workflow file: .github/workflows/build.yml

Add the environment section to match your system and plugin set IDs:

env:
  PLENTY_ID: 70503   # your PlentyONE system ID (from the email, e.g. p70503)
  SET_ID: 1          # the plugin set you want to build inside that system

Note: You need a GitHub Action for each plugin set.

💻 Alternative via CLI (for multiple systems) If you want to test against multiple systems, use the plentymarkets/dev-sync CLI.

Find the plentymarkets/dev-sync repository here plentymarkets/dev-sync.

License

This project is licensed under the GNU AFFERO GENERAL PUBLIC LICENSE - see the LICENSE.md file for details.

About

Our "Hello World!" plugin

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 11