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

Standard app release metadata format #1992

Open
evant opened this issue Nov 25, 2024 · 4 comments
Open

Standard app release metadata format #1992

evant opened this issue Nov 25, 2024 · 4 comments
Labels
blocked This is dependent on external changes enhancement New feature or request source-specific This bug/feature affects a specific source

Comments

@evant
Copy link

evant commented Nov 25, 2024

Describe the feature
Hi! I've started my own project to make it easier self-distribute apps https://github.com/evant/self-update and I feel like it has a lot of overlap with the goals of this project. In particular, I'm working on defining a release manifest json format that provides the information needed to install updates including apk splits. So my questions are:

  1. Would it be useful to consume this manifest as well, possibly as an additional source?
  2. What information would be most useful to include in the manifest?

Describe alternatives you've considered (if applicable)

  • It may be possible to use existing sources in some cases, for example publishing to github releases. I'd imagine other cases, like publishing to an s3 bucket would be more difficult.
  • It also may be possible to use the HTML source that's configured to read the needed information out of the json file if that's possible. (I haven't tested if pointing an HTML source to a json file actually works). This would be more work for the consumer to set up.

Additional context
Here's a link to the current documentation for the manifest format, though it's very much a work in progress.
https://github.com/evant/self-update?tab=readme-ov-file#manifest-format

@evant evant added enhancement New feature or request to check Issue has not been reviewed labels Nov 25, 2024
@ImranR98
Copy link
Owner

I think it should be possible to use the HTML source for vary basic support (no picking between architectures etc.) as long as the JSON path property is an absolute URL.

It's a good idea, but probably too early to consider adding support for this as a proper source - I'd want to wait until the API is stable and the system has been adopted by others to some extent.

@ImranR98 ImranR98 added blocked This is dependent on external changes source-specific This bug/feature affects a specific source and removed to check Issue has not been reviewed labels Nov 26, 2024
@evant
Copy link
Author

evant commented Nov 26, 2024

Sounds reasonable, I do plan to have the option to include a universal apk will try to get it working with that in the meantime

@frmz
Copy link

frmz commented Dec 5, 2024

Hi! I am an app developer (KWGT Android), i distribute my app also through my own website via APK links. A user is now asking to make my website "obtainium" compatible, i guess that it would be a lot easier if there was a JSON format i could use rather than reverse engineering your HTML parser to make the download page "readable". So i am subscribing to this page hoping there will be eventually a machine readable format i could use to make my downloads easily available to it.

@evant
Copy link
Author

evant commented Dec 6, 2024

Can confirm that the html source works. Will just document what the settings should be for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked This is dependent on external changes enhancement New feature or request source-specific This bug/feature affects a specific source
Projects
None yet
Development

No branches or pull requests

3 participants