Page MenuHomeSoftware Heritage
Create Task
Maniphest T1101

fetch release note from github to keep in release_metadata table
Closed, MigratedEdits Locked
Actions

Description

In the web-app when browsing a release, the release message can be the release name and provide very little information, because the only message kept is the one stored in git.
See: https://archive.softwareheritage.org/browse/origin/https://github.com/RaRe-Technologies/gensim/releases/

On Github the release page has a detailed description that should be kept with the release.

Example:
https://github.com/RaRe-Technologies/gensim/releases/tag/3.4.0

"body" element in :
https://api.github.com/repos/RaRe-Technologies/gensim/releases/tags/3.4.0

Two options:

  1. have it directly in the release object
  2. create a release_metadata table for all the stuff found with the release including assets or links to assets
  3. put in ERMDS on the release SWHID

Related Objects
Search...

Event Timeline

moranegg triaged this task as Low priority.Jun 13 2018, 3:59 PM
moranegg created this task.
moranegg updated the task description. (Show Details)
olasd added a subscriber: olasd.Jun 13 2018, 4:04 PM

In my opinion, the release notes shouldn't be stored in the release objects, for the following reasons:

  • they are dependent of the origin (a clone of this exact same repository on another git hosting platform won't have that information)
  • they aren't part of the data used to compute the release identifier
  • they can be modified after the fact

They're really external metadata, dependent of the context, and should be stored as such

moranegg renamed this task from fetch release note from github to keep with release object to fetch release note from github to keep in release_metadata table.Jun 13 2018, 4:07 PM
moranegg removed a parent task: T17: handle github assets in git loader.Jun 13 2018, 4:18 PM
moranegg added a parent task: T1102: Handle all GitHub elements.Jun 13 2018, 4:24 PM
moranegg mentioned this in T2059: Generate (swh) releases from all git tags.Nov 5 2019, 1:35 PM
moranegg updated the task description. (Show Details)Jan 13 2021, 10:53 AM
gitlab-migration closed this task as Migrated.Jan 8 2023, 4:59 PM
gitlab-migration claimed this task.
gitlab-migration added a subscriber: gitlab-migration.

This task has been migrated to GitLab.

About · Developer information · Legal