Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Component manager - Improve components_available.json #137

Open
chaveiro opened this issue Sep 30, 2021 · 1 comment
Open

Component manager - Improve components_available.json #137

chaveiro opened this issue Sep 30, 2021 · 1 comment

Comments

@chaveiro
Copy link

chaveiro commented Sep 30, 2021

This file https://github.com/openenergymonitor/EmonScripts/blob/658d982aa968076071d46df87ab9174d3c9df1e7/components_available.json is used directly from Modules/admin/admin_model.php components_available() function at the follow address:
https://raw.githubusercontent.com/openenergymonitor/EmonScripts/stable/components_available.json

Suggest to add :

  • description -> optional text that appear on the component module list
  • branches_available -> optional install branches
  • isModule -> true if it's a standard emoncms module
  • install_path -> optional location if installation is not %emon_path%/modules Dont use hard coded absolute paths, use template like %var% that gets replaced by installation script to accommodate different servers.

Example:

{
  "emoncms":{
    "name":"Emoncms Core",
    "description": "Some text about this module that appear on the component module list",
    "url":"https://github.com/emoncms/emoncms.git",
    "branches_available ": {"master", "stable"},
    "install_path": "%emon_path%",
    "isModule": false
  },
  "app":{
    "name":"App",
    "url":"https://github.com/emoncms/app.git",
    "description": "Some text about this module that appear on the component module list",
    "branches_available ": {"master", "stable"},
    "install_path": "",
    "isModule": true
  }
}

emoncms/emoncms#1732

@chaveiro chaveiro changed the title Improve component manager - use components_available.json public URL Component manager - Improve components_available.json Sep 30, 2021
@borpin
Copy link
Contributor

borpin commented Jan 29, 2023

@chaveiro - this seems to have been incorporated into the new 'Components' section of the admin interface. Can this be closed as a result of that?

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

No branches or pull requests

2 participants