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

[FEATURE REQUEST] Generate AppConfig spec file from OCClassSettings metadata automatically #842

Open
9 tasks
felix-schwarz opened this issue Nov 23, 2020 · 6 comments
Assignees
Labels
feature:MDM all kind of MDM / EMM related features
Milestone

Comments

@felix-schwarz
Copy link
Contributor

felix-schwarz commented Nov 23, 2020

Is your feature request related to a problem? Please describe.
In ownCloud app we have a comprehensive set of settings which can be used for branding, MDM, configuration during development. AppConfig spec files are maintained manually.

When a new setting is added or an existing setting is changed in code, class settings metadata should be used to automatically generate an updated version of the AppConfig spec file.

Describe the solution you'd like
A script, unit test or tool using the OCClassSettings metadata to generate the AppConfig spec XML files automatically.

It should generate different versions with varying degrees of detail/sets of settings based on the status.

RELATED ISSUES

#755 on automatic generation of documentation from metadata.

TASKS

  • Research (if needed)
  • Create branch feature/feature_name
  • Development tasks
    • Implement whatever
    • ...
  • Code review and apply changes requested
  • Design test plan
  • QA
  • Merge branch feature/feature_name into master
@felix-schwarz felix-schwarz changed the title [FEATURE REQUEST] Generate AppConfig.xml from OCClasseSettings metadata automatically [FEATURE REQUEST] Generate AppConfig spec file from OCClassSettings metadata automatically Nov 23, 2020
@felix-schwarz felix-schwarz added the feature:MDM all kind of MDM / EMM related features label Nov 23, 2020
@felix-schwarz felix-schwarz added this to the 11.5.0-Next milestone Nov 23, 2020
@michaelstingl
Copy link
Contributor

  • Default AppConfig spec file should only contain recommended settings.
  • Categories can be used for group feature in spec file

@michaelstingl
Copy link
Contributor

Source data:
https://github.com/owncloud/ios-app/blob/master/doc/CONFIGURATION.json

We already generate docs/modules/ROOT/pages/ios_mdm_tables.adoc
Maybe also move to enterprise/MDM?

Some old specfiles:
https://github.com/owncloud/ios-app/tree/master/enterprise/MDM/AppConfig

Specfiles can be generated manaually:
https://beta.appconfig.jamfresearch.com/spec-creator
(import/edit/export)

Generated specfiles can be used here:
https://beta.appconfig.jamfresearch.com/generator
(import/edit/save as *.plist)

Here's the detailed spec:
https://storage.googleapis.com/appconfig-media/appconfig-content/uploads/2017/01/ManagedAppConfig.pdf

More information:
https://www.appconfig.org/

@michaelstingl
Copy link
Contributor

Parameter should be grouped by categoryTag, displayed as category.

Key is the flatIdentifier

@michaelstingl
Copy link
Contributor

We could use GitHub Actions to run this automatically, similar to the MDM tables.

@mmattel
Copy link
Contributor

mmattel commented Nov 1, 2021

Maybe also move to enterprise/MDM

It would be great to have one location (tbd, but not inside the docs folder) for all files which are and will be generated for docs or are docs relevant, so we have a single location for those files.

@michaelstingl
Copy link
Contributor

We already generate docs/modules/ROOT/pages/ios_mdm_tables.adoc
Maybe also move to enterprise/MDM?

Better move to doc/CONFIGURATION.adoc (#1070)

michaelstingl added a commit that referenced this issue Jul 13, 2023
One day, it will be auto-generated…
- #842
michaelstingl added a commit that referenced this issue Jul 20, 2023
One day, it will be auto-generated…
- #842

Co-authored-by: Michael Stingl <git@michaelstingl.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature:MDM all kind of MDM / EMM related features
Projects
None yet
Development

No branches or pull requests

4 participants