📦 version 3

[chris48s]

There's a lot going on in this pull request. Fortunately, because we've worked on it in small chunks, most of it has already been reviewed :)

Commits edbad19, cf3612d, 544f4e6, f3f95b7 and fc16600 have all been reviewed already. The relevant PRs are linked in the commit messages, although they've now been though some rebasing to get the branch up to date with master.

Commit 2c02630 and onwards are all new in this PR, but its mostly moving stuff about and a final review/update on the docs.

The next steps I think we should make on this are:

• Merge this and deploy it. Then shields.io will be finally running off the new package code, including new template code introduced in Template literal templates #4459
• Publish a beta/release candidate to NPM using the new package name
• Monitor production for errors. We're the biggest user of our own package. I suspect if we've overlooked any bugs we'll spot them pretty fast once we're using it in production
• Publish a stable release using the new package name
• Publish a final gh-badges 2.2.2 release advising users to upgrade
• Mark gh-badges dead/unmaintained on NPM
• Start work on v3.1

but happy to discuss it.

Just to review the roadmap/issues:

• Merging this closes NPM audit vulnerability on dependency of gh-badges package #3480
• Merging this closes PNG/JPG/GIF support: to raster or not to raster? #4564
• This PR contains all the changes discussed in version 3 roadmap for npm package #3587 which require a BC-break. When we merge this I will close that and raise new issues for:
  • Expose the concept of logos, add SimpleIcons as a peer dependency
  • Depend on the public interface internally instead of relative imports
  • Add typescript definitions to make package easier to use with TypeScript
    We can make those changes later/in a feature release without breaking backwards compatibility.

Usual review process aside, it would be particularly useful to get another set of eyes on the documentation to make sure we're all up-to-date and the migration advice in the changelog is correct.

[chris48s]

• I've already published a package that does nothing at https://www.npmjs.com/package/badge-maker just to stake a claim on the name.
• I'm suggesting the first release is -rc1 here, but I don't really have strong opinions on whether it should be -beta or whatever..

[shields-ci]

	Warnings
⚠️	This PR modified the server but none of its tests. That's okay so long as it's refactoring existing code.
⚠️	This PR modified helper functions in lib/ but not accompanying tests. That's okay so long as it's refactoring existing code.

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

Generated by 🚫 dangerJS against 3208623

[calebcartwright]

Only a handful of service test failures that were unrelated 👍

[calebcartwright]

Few minor items left inline, but LGTM and happy to re-👍 if you decide to make any other changes.

Definitely helps that this was done in chunks like you said, as I'd forgotten how fun a few of those earlier commits like f3f95b7 were 😁

[chris48s]

Whoops - have updated with a fix.

[chris48s]

I've slightly lost track of what's deployed at this point, but are we pretty happy we've now ironed out the kinks with this?

[paulmelnikow]

The live one is 4999e55. I think we're confident it doesn't have major bugs.

I'm okay with merging this.

Has anyone evaluated how s0 is performing compared to historical?

[chris48s]

Cool, thanks. In that case I'm going to crack on and merge this, push the release candidate and review the next steps..

[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:

[platan]

After merging this PR I got an email from Heroku: "Automatic deployment of shields-staging failed".

[chris48s]

Hmm. Thanks - good spot. The error it is failing with is

npm ERR! syscall access
npm ERR! path /tmp/build_213196dfe99649b0be38d9bc6dc323c7/node_modules/gh-badges
npm ERR! errno -2
npm ERR! enoent ENOENT: no such file or directory, access '/tmp/build_213196dfe99649b0be38d9bc6dc323c7/node_modules/gh-badges'
npm ERR! enoent This is related to npm not being able to find a file.
npm ERR! enoent 

I wonder if there is some cache that needs to be cleared? The staging PRs were deploying correctly.

[chris48s]

I've set NODEMODULESCACHE=true in the env vars for the staging pipeline, but I can't see a way to retry the deploy without pushing another commit to master. I'm going to check back on it tomorrow (inevitably we'll merge some dependency bumps tomorrow). If that fixes it, I'll unset the env var to re-enable the cache. If that doesn't fix it then I'll worry about it some more.

[paulmelnikow]

I think you can do that here, want to give it a try?