search

jlnrrg / simple_icons

The Simple Icon pack available as Flutter Icons. Provides over 1500 Free SVG icons for popular brands.
Creative Commons Zero v1.0 Universal
27 stars 6 forks source link

Update Simple Icons Version #103

Closed adamrusted closed 5 months ago

adamrusted commented 11 months ago

From the next major release of simple-icons (v11, releasing on May 26, 2024), We will begin removing third-party extensions from our README list that are not up to date with at least the previous major release. For example, when v11 is released, we will remove any extensions that don't support v10.0.0 or higher.

How do I keep my package up to date?

There are two methods that prove most popular among other maintainers. It is up to you which you implement.

Using @latest from a CDN

Projects that use the CDN version of the project (jsDelivr/unpkg) can keep up to date simply by changing the version number in their code to @latest. That way - you're always using the most up to date version of the icon package.

Running a weekly CRON

Many of our third party contributors make use of GitHub actions, and a weekly CRON job to query that the version number of the main package has changed, and then update and build their own package. A great example of this is the DrawIO package by mondeja. The main package is released consistently on a Sunday - so we recommend running your CRON job on a Monday or Tuesday.

When you've got your extension running one of the above methods, drop us a Pull Request to update your version number on the README.

If you're in need of any support in implementing one of the above - please feel free to start a discussion or ask us on Discord.

adamrusted commented 5 months ago

Heads up @jlnrrg - as of v12 releasing on Sunday 26th May, this package is no longer listed under the Simple Icons extensions. If you bring it in line with the notes above we can look to re-add it to the list.

jlnrrg commented 5 months ago

@adamrusted Thank you for being this patient with me and also for the reminder 😊. As life has been quite busy for me, I only made time today to work on the auto update. The repository you linked was of tremendous help to me, so thank you for that. I hope that the repository now meets the new guidelines. If that is not the case, please mention to me what should be improved and I try to make time earlier this time 😅 .

adamrusted commented 5 months ago

Amazing, thank you! Do you have an obvious JSON / XML file we can pull the version number from to ensure this is kept up to date? If so, I'll look to re-add it to our list.

jlnrrg commented 5 months ago

If possible, please use the pubspec.yml as this is the package.json equivalent of a dart package. And I match the version to your version number. If you need a json/xml file, I can also add an entry in the build script which creates such a file for you.

adamrusted commented 5 months ago

I can see you've got https://github.com/jlnrrg/simple_icons/blob/master/vendor/package.json too - which contains versions of both our main package and the font. Assuming that gets updated every time you push an upgrade?

jlnrrg commented 5 months ago

You are correct 👍

adamrusted commented 5 months ago

Awesome, I'll get your package merged back into the README shortly. Thanks for your help with this!