Common Bugs and Solutions

There are some bugs that the automation might run into. Listed below are the common ones and their solutions

1. Icon created by Icomoon contains strange lines that aren't in the SVG

   • See this PR's peek result.
   • This is caused by a bug in Icomoon's parser (see this).
   • Solution: Luckily this is an extremely rare case. Try remaking the SVG in a different way (using different paths/shapes). If your text/paths are joined with another object (say, the logo), try splitting them into individual paths (see this PR). You can always test using Icomoon to see if your fix works.

2. Icon created by Icomoon is a solid black shape

   • This can be caused by one of the following reasons:
   • The background or cutout in the middle of the logo is not transparent. Most of the time, these areas are white-filled, which will be stripped by Icomoon and turned into a black area -> Solution: remove or cut out these areas using an SVG editor.
   • The <clipPath> element is not interpreted correctly by the Icomoon parser. -> Solution: Convert <clipPath to normal path or shapes.

3. SHA Integrity

   • See this action for an example.
   • Caused by the package-lock.json. Most likely the result of a dependabot update but not 100% sure.
   • Solution: Remove the package-lock.json and run `npm install` to generate a new file. Commit and push.

4. Wrong PR Title

   • The bot-peek script relies on the PR title to find the icon that was added in the PR. If the format doesn't match what is specified in Overview on Submitting Icon, the bot will fail.
   • Solution: Ensure the name of the PR follows the convention.

5. No connection could be made because the target machine actively refused it. (os error 10061)

   • See this action for an example.
   • Caused by Selenium picking a random port to host their server and GitHub blocking it. This issue should be fixed in #966. It hasn't occur again after we picked 8080 as the port for Selenium to use.
   • Solution: if it one day breaks, wait for 10 minutes and rerun the script. Repeat until it works.