tskit-dev / tskit-site

tskit website
Other
0 stars 8 forks source link

Show version number instead of release text for software #27

Closed jeromekelleher closed 3 years ago

jeromekelleher commented 3 years ago

On the software pages, I think it would be more useful to show the release version rather than the label text, i.e., we'd have

Latest version: 1.0.0b3 1 week ...

for msprime. The release names aren't terribly helpful a lot of the time.

benjeffery commented 3 years ago

Here is the JSON that we get from github. I guess the tag is the nearest thing to the version number, but not sure that is the case for all of the projects.

  {
    "url": "https://api.github.com/repos/tskit-dev/msprime/releases/27035724",
    "assets_url": "https://api.github.com/repos/tskit-dev/msprime/releases/27035724/assets",
    "upload_url": "https://uploads.github.com/repos/tskit-dev/msprime/releases/27035724/assets{?name,label}",
    "html_url": "https://github.com/tskit-dev/msprime/releases/tag/0.7.5",
    "id": 27035724,
    "author": {
      "login": "jeromekelleher",
      "id": 2664569,
      "node_id": "MDQ6VXNlcjI2NjQ1Njk=",
      "avatar_url": "https://avatars.githubusercontent.com/u/2664569?v=4",
      "gravatar_id": "",
      "url": "https://api.github.com/users/jeromekelleher",
      "html_url": "https://github.com/jeromekelleher",
      "followers_url": "https://api.github.com/users/jeromekelleher/followers",
      "following_url": "https://api.github.com/users/jeromekelleher/following{/other_user}",
      "gists_url": "https://api.github.com/users/jeromekelleher/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/jeromekelleher/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/jeromekelleher/subscriptions",
      "organizations_url": "https://api.github.com/users/jeromekelleher/orgs",
      "repos_url": "https://api.github.com/users/jeromekelleher/repos",
      "events_url": "https://api.github.com/users/jeromekelleher/events{/privacy}",
      "received_events_url": "https://api.github.com/users/jeromekelleher/received_events",
      "type": "User",
      "site_admin": false
    },
    "node_id": "MDc6UmVsZWFzZTI3MDM1NzI0",
    "tag_name": "0.7.5",
    "target_commitish": "hotfix-0.7.4",
    "name": "Dummy release to update docs",
    "draft": false,
    "prerelease": false,
    "created_at": "2020-05-29T14:31:10Z",
    "published_at": "2020-05-29T14:47:37Z",
    "assets": [

    ],
    "tarball_url": "https://api.github.com/repos/tskit-dev/msprime/tarball/0.7.5",
    "zipball_url": "https://api.github.com/repos/tskit-dev/msprime/zipball/0.7.5",
    "body": "This is a dummy release to allow us to update the \"stable\" docs branch on readthedocs. This is to correct an error in the version of the Out of Africa model described in the tutorial. See [here](https://github.com/jeromekelleher/msprime-model-errors) for full details."
  },
jeromekelleher commented 3 years ago

tag_name seems good, let's try that out and see what happens.