Add operational process section for update management #17
Conversation
|
|
||
| This section describes the concrete steps OED maintainers should follow to keep update notifications accurate and consistent. | ||
|
|
||
| ### When a new OED release is published |
There was a problem hiding this comment.
Section headers should have a blank line before/after.
Also, indenting should be with 2 spaces and not tabs for markdown.
|
Hi @huss , thank you for the feedback! I’ve added:
The section headers were also formatted with blank lines as requested. Please let me know if any further adjustments are needed. |
Adds the exact GitHub Pages location for latestVersion.json, a full JSON schema example, and documents how to generate and publish SHA-256 checksums as GitHub release assets.
| #### Step 2: Check Only When an Admin Logs In | ||
|
|
||
| - OED performs this fetch: GET https://oed-project.github.io/latestVersion.json | ||
| - OED performs this fetch: GET https://openenergydashboard.github.io/DesignDocs/update-metadata/latestVersion.json |
There was a problem hiding this comment.
I don't think this should reference the design docs. Maybe under update-metadata/latestVersion.json?
| Your OED version is no longer supported. Please upgrade soon. | ||
|
|
||
| Additional improvements: | ||
| - Show current version |
There was a problem hiding this comment.
I'm unclear on how these are provided by the JSON file that is received.
| - Sites can verify downloads without needing new infrastructure | ||
| - Fits GitHub’s security model | ||
|
|
||
| How to generate SHA-256 checksums |
There was a problem hiding this comment.
From a web search, it seems you can use GitHub actions to automatically generate the checksum for a release. Also, there is a way to add it to the GitHub release as a note. I think these should be figured out and included.
| ### When a new OED release is published | ||
|
|
||
|
|
||
| 1. Update the version metadata file: DesignDocs/docs/update-metadata/latestVersion.json |
There was a problem hiding this comment.
I think a sample should be linked and/or the actual one in this design doc folder.
2 participants
This PR adds an "Operational Process for OED Maintainers" section to clarify how the proposed update-notification system would be maintained in practice.
It documents:
This is intended to make the proposal easier to implement and maintain long-term.