Allow [GitHub] tag badge to sort by date

[chris48s]

Following on from #2117 (comment)

• I've modified the /release badge so we can use /release-pre and changed the home pages example. The legacy /all suffix will still work (for backwards-compatibility) but its not documented.
• I haven't changed anything else on /release. Looking into it, we're using the prerelease key there rather than assuming semver so we don't have the same issue there that we do with tags.
• I've added a tag-date endpoint. I changed my mind and decided not to go with sort=semver/sort=date for 2 reasons:
  • It allows /tag-pre/username/repo.svg?sort=date which is a bit odd/unclear
  • We don't really have a good way to get the querystring in BaseJsonService. This is going to be a problem with a few other services which we need to deal with when we port them, but on reflection I'd prefer not make this problem bigger.

This PR won't change the behaviour for anyone already using these badges but improves consistency and provides a way for projects that don't use SemVer (for whatever reason) to use the /tag badge with sensible expected behaviour.

Does this seem reasonable?

[shields-ci]

	Messages
📖	✨ Thanks for your contribution to Shields, @chris48s!
📖	Thanks for contributing to our documentation. We ❤️ our documentarians!

Generated by 🚫 dangerJS

[chris48s]

side issue: one of the tests was failing because the GH API now returns spdx_id: "NOASSERTION" when it can't identify the licence (at least in some cases), so I've fixed that while I'm here..

[RedSparr0w]

👍 Changes look great to me.
Just left a minor note in regards to the regex, although this is fine to merge with whichever option you decide. 😄

[RedSparr0w]

Do you think it would be better to make the - required for tag-pre?

-/^\/github\/(tag-?pre|tag-date|tag)\/([^/]+)\/([^/]+)\.(svg|png|gif|jpg|json)$/
+/^\/github\/(tag-pre|tag-date|tag)\/([^/]+)\/([^/]+)\.(svg|png|gif|jpg|json)$/

or an alternative:

/^\/github\/tag(?:-(pre|date))?\/([^/]+)\/([^/]+)\.(svg|png|gif|jpg|json)$/ (- required)
/^\/github\/tag(?:-?(pre|date))?\/([^/]+)\/([^/]+)\.(svg|png|gif|jpg|json)$/ (- optional)

[chris48s]

I was keeping this to avoid making a breaking change:

shields/services/github/github-tag.service.js

Line 18 in 7ea540d

/^\/github\/tag(-?pre)?\/([^/]+)\/([^/]+)\.(svg|png|gif|jpg|json)$/,

..but now you mention it, one of the issues here was we've never put an example of this on the home page so I doubt there is much usage in the wild. It was only added quite recently. Lets change it now 👍

[RedSparr0w]

Ah yes, Good point!

[RedSparr0w]

Do you think it would be better to make the - required for tag-pre?

-/^\/github\/release(-?pre)?\/([^/]+\/[^/]+)(?:\/(all))?\.(svg|png|gif|jpg|json)$/,
+/^\/github\/release(-pre)?\/([^/]+\/[^/]+)(?:\/(all))?\.(svg|png|gif|jpg|json)$/,

[shields-deployment]

This pull request was merged to master branch. This change is now waiting for deployment, which will usually happen within a few days. Stay tuned by joining our #ops channel on Discord!

After deployment, changes are copied to gh-pages branch:

[paulmelnikow]

Catching up on some reading!

We don't really have a good way to get the querystring in BaseJsonService. This is going to be a problem with a few other services which we need to deal with when we port them, but on reflection I'd prefer not make this problem bigger.

Could you clarify what you mean? I added some query param support in #1589. The handling of examples isn't completely correct as we've seen, and it's not stripping the default parameters, though the core of the query params are working in the the (new-style) NPM badges.

[chris48s]

Sorry - turns out I'm mistaken on this. I hadn't seen an example where we've used the queryParams arg to handle() before, but its good to know its there. That's one less thing to worry about :)