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

Add stable link to latest oemetadata version #26

Closed
danielhuppmann opened this issue Jan 22, 2020 · 9 comments · Fixed by #29
Closed

Add stable link to latest oemetadata version #26

danielhuppmann opened this issue Jan 22, 2020 · 9 comments · Fixed by #29
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@danielhuppmann
Copy link

I'm a bit confused by having version numbers hard-coded in the folder structure. Say I want to include a link to the latest metadata version, is there a smarter approach than linking to the entire repository?

@Bachibouzouk
Copy link
Contributor

@4lm, as you implemented the repository's structure, could you reply to this?

@4lm
Copy link
Collaborator

4lm commented Jan 22, 2020

IMO to be explicit is a good thing, because the folder structure also work as modules for the Python implementation. This repo is IMO a living code base and not a fixed resource for linking against an permanent URL. As I suggested in #22 you could put the schemas on zenodo.org, there you also get a DOI and a permalink which always links to the lasted version.

@Ludee Ludee changed the title Metadata version referencing Add stable link to latest oemetadata version Apr 16, 2020
@Ludee Ludee added bug Something isn't working documentation Improvements or additions to documentation labels Apr 16, 2020
@jh-RLI
Copy link
Contributor

jh-RLI commented Apr 16, 2020

@Ludee Should we host the files on zenodo.org? We could also offer these on the oep?

@jh-RLI
Copy link
Contributor

jh-RLI commented Apr 16, 2020

#16

@Ludee
Copy link
Member

Ludee commented Apr 16, 2020

They are example files for "data packages". So they can be used as examples and templates to upload data. But it makes sense to have them as live examples in the database as well.
Zenodo is an option to have a DOI to cite in publications.

An easy solution is a folder oemetadata-latest and have a copy without version number on master branch. Then we have a stable url.
Perhaps there are better solutions.

@christian-rli
Copy link
Contributor

I agree that being explicit is good, so I approve of version numbers benig hard coded in the folder names. I also like @Ludee 's suggestion to use oemetadata-latest. This is also used for data downloads that change frequently, for example in openstreetmap.

@jh-RLI
Copy link
Contributor

jh-RLI commented May 13, 2020

Generally, I think we should publish the OEM via the OEP or the API (or both). On the one hand, this will make the platform affiliation clear (even if oemetadata is quite clear) and on the other hand, we have a clear release without confusion about the current/latest release and also make the OEM more publicly available even outside of GitHub. This would complete the representation of OEM on the OEP, as we already have the functionality to create, read and edit OEM implemented on the OEP.

I see three options here:

  1. implementing the oemetadata-latest folder (and link it on the OEP)
  2. Implement a new view/API function on the OEP that publishes the latest version of the OEM (from static file or database), a new OEM release would trigger a deployment procedure that includes updating the OEM version on the OEP
  3. Use Zenodo

@jh-RLI
Copy link
Contributor

jh-RLI commented May 13, 2020

I think the implementation of a "latest-release" and a "current" version is reasonable. Therefore I would implement this structure regardless of the option chosen here.

@jh-RLI
Copy link
Contributor

jh-RLI commented May 13, 2020

Since the discussion, there is related to this issue: OpenEnergyPlatform/omi#26

@MGlauer What do you think about this:

  1. Implement a new view/API function on the OEP that publishes the latest version of the OEM (from static file or database), a new OEM release would trigger a deployment procedure that includes updating the OEM version on the OEP

@jh-RLI jh-RLI linked a pull request Jun 11, 2020 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants