Skip to content

A required attribute for environment variables in "Deploy Options" #695

@kyteinsky

Description

@kyteinsky

Describe why it is important and where it will be useful

Some environment variables/admin options are required and an ability to clearly communicate that would be nice, otherwise if the docs are not read, the realisation is late and only visible in the logs of the Ex-Apps.
One such example is this env var which is required for the app to function but the admin is not prompted for it automatically: https://github.com/nextcloud/live_transcription/blob/311a2e679f7e8e3d53651f35009a9006234423bf/appinfo/info.xml#L32-L37
https://github.com/nextcloud/live_transcription/blob/311a2e679f7e8e3d53651f35009a9006234423bf/ex_app/lib/utils.py#L67-L70

Describe your proposed solution

A required attribute should be added to the info.xml environment variable declation and prevent the app from being installed if it's unset. Environment variables can be termed as "set" even when their value is "" so not sure how the UI should work but in any case, the environment variables modal (Deploy Options) should be prompted in such cases.
This requires changes in the server repo as well for the UI part.

Describe alternatives you've considered, if relevant

No response

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    deployRelated ExApp deploymentenhancementNew feature or requestphpPull requests that update Php codepriority: medium

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions