Feature: Peek and Build-Bot Upgrade #806

Thomas-Boi · 2021-08-12T23:59:19Z

Hello guys,

This is a big upgrade of our build/peek workflow. I thought of splitting it up into multiple PRs but there are a lot of similar aspects (peek-bot and build-bot has the same superclass, the footer upgrade is a part of the build-bot). I apologize in advance if this is a lot and feel free to take your time to review this.

Here is a list of features according to categories:

peek-bot:

Feature:
- Now let us know whether an icon contains strokes when uploading them to Icomoon. This is a secondary check to an upcoming checkSvg update
- Take snapshots of the ICONS version generated by Icomoon. The images seen on the "Generate Font" page of Icomoon is actually what the final font version look like. peek-bot now takes a picture of that.
- Improved messaging to display the images
- PR title can now be either "new icon" or "update icon". This is merely a semantic change so it looks clearer in the PR tab and release message
Things maintainer should know:
- The glyph counts should match the number of icons selected (see the peek-bot's PR message, I added a list of things we should look out for). If not, something went wrong => could be because color is not stripped properly.
Test:
- See this PR to see a test case where there are NO STROKES in the SVG.
- See this PR to see a test case where there are STROKES in the SVG.

build-bot:

Feature:
- Now takes picture of the icons generated by Icomoon
- Also checks for strokes in SVGs and duplicated icons. If these happen, build script will fail.
- Incorporate get_release_message workflow into the build-bot. We don't have to run the two scripts separately anymore.
- optimizer-bot (a part of build-bot):
  - Will append a \n to each SVG after it's optimized (looking at you *nix users)
  - Will prefix the classes -> SVGs can now use classes and <style> tags with no issues.
Things maintainer should know:
- The build release message is now included in the PR message. You can copy it by hovering over the top right corner of the release message section.
- Please check the files via "Edit Files" to see the \n in the SVG files. For some reason, GitHub don't display them but they are there. You can download the file and check locally as well => the \n will be there.
Test:
- See this PR to see the built-bot's result.
- Here's the Actions log for it.

Both the upgrades require merge into master due to the workflow_run events in the related workflow files.

After this PR, I have another one for checkSvg. After that, we can create a new release.

amacado

This is crazy! 👍🏻 @Thomas-Boi amazing how much effort you bring in!

Panquesito7

I don't know anything about Python and I'm not that experienced in this area, but overall, everything looks amazing! Awesome work, @Thomas-Boi! 😄

Panquesito7 · 2021-08-13T15:52:10Z

.github/scripts/icomoon_build.py

        filehandler.extract_files(str(zip_path), args.download_path)
        filehandler.rename_extracted_files(args.download_path)
+
+        print("Creating the release message by querying GitHub API...")


Suggested change

print("Creating the release message by querying GitHub API...")

print("Creating the release message by querying the GitHub API...")

Panquesito7 · 2021-08-13T15:53:30Z

.github/workflows/post_peek_screenshot.yml

-            Thank you for contributing to Devicon! I hope everything works out and your icons are accepted into the repo.
+            In case of font issues, it might be caused by Icomoon not accepting strokes in the SVGs.  Check this [doc](https://icomoon.io/#faq/importing) for more details and fix the issues as instructed by Icomoon and update this PR once you are done.
+
+            Thank you for contributing to Devicon! I hope that your icons are accepted into the repo.


Suggested change

Thank you for contributing to Devicon! I hope that your icons are accepted into the repo.

Thank you for contributing to Devicon! I hope that your icons are accepted into the repository.

Panquesito7 · 2021-08-13T15:53:51Z

.gitignore

+new_icons.png
+screenshots/
+release_message.txt


Suggested change

release_message.txt

release_message.txt

Thomas-Boi · 2021-08-13T18:31:24Z

gulpfile.js

@@ -21,7 +23,7 @@ async function createDeviconMinCSS() {
  await createCSSFiles();

  let deviconMinPath = path.join(__dirname, finalMinSCSSName);
-  // recall that devicon-alias.scss imported the devicon.css => don't need
+  // recall that devicon-alias.scss imported the devicon-icomoon.css => don't need


Suggested change

// recall that devicon-alias.scss imported the devicon-icomoon.css => don't need

// recall that devicon-alias.scss imported the devicon-base.css => don't need

Co-authored-by: David Leal <[email protected]>

Thomas-Boi · 2021-08-13T18:37:06Z

Two things I forgot to mentioned:

I renamed the devicon.css into devicon-base.css. People keep thinking that the devicon-min.css is an optimized version of that, which is only half-correct. Hopefully, a rename will make it clearer that this is not the case.
The images in the build-bot test example were reversed. This has been fixed in e72f344.

Panquesito7

As I said previously, I don't know anything about Python or related to this area, but the changes mentioned in the first comment look good. Huge thanks and awesome work, @Thomas-Boi! 😄

Thomas-Boi · 2021-08-13T18:51:18Z

Thank you for reviewing the changes! This took me quite a while and I'm happy that everything went well. We can start making a new release and putting the bot to work 😄

* Refactored peek script into a class * Post-peek workflow now upload the new screenshots * Refactored BuildSeleniumRunner into a class * Updated build_icons.yml to reflect new changes * Fixed issue with building icons that were already in the app * Build script will take screenshot of new icons * Update post peek yaml message * Added alerts * Peek script now check for strokes in icons * Updated post_peek's strokes in svgs message * Updated post_peek script's message * Updated post_peek's message * Refactored get_release_message into icomoon_build * Change devicon.css name to devicon-base.css * Updated post_peek message * Added update icon as a valid PR title for bot-peek * Add \n char to SVG after it gets optimized * Fixed error with 'update icon' regex * Build script now batch issues when upload SVG * Addressed build-bot's screenshot order * Apply suggestions from code review Co-authored-by: David Leal <[email protected]> Co-authored-by: David Leal <[email protected]>

Thomas-Boi added 20 commits August 12, 2021 14:31

Refactored peek script into a class

cb68468

Post-peek workflow now upload the new screenshots

8e0c06c

Refactored BuildSeleniumRunner into a class

53bc65e

Updated build_icons.yml to reflect new changes

6e1cda1

Fixed issue with building icons that were already in the app

38cf20c

Build script will take screenshot of new icons

b052112

Update post peek yaml message

248e8e7

Added alerts

d340261

Peek script now check for strokes in icons

b9d66c1

Updated post_peek's strokes in svgs message

03c7640

Updated post_peek script's message

1a25f6f

Updated post_peek's message

c477e8d

Refactored get_release_message into icomoon_build

5c6d92b

Change devicon.css name to devicon-base.css

8f5ab94

Updated post_peek message

4623f7f

Added update icon as a valid PR title for bot-peek

5c91c27

Add \n char to SVG after it gets optimized

853c86f

Fixed error with 'update icon' regex

71b84f0

Build script now batch issues when upload SVG

2871bb0

Addressed build-bot's screenshot order

e72f344

Thomas-Boi requested review from amacado and Panquesito7 August 12, 2021 23:59

Thomas-Boi added devops Use this label for devops related enhancements enhancement labels Aug 12, 2021

amacado previously approved these changes Aug 13, 2021

View reviewed changes

Panquesito7 reviewed Aug 13, 2021

View reviewed changes

Thomas-Boi commented Aug 13, 2021

View reviewed changes

Apply suggestions from code review

73643f6

Co-authored-by: David Leal <[email protected]>

Thomas-Boi dismissed amacado’s stale review via 73643f6 August 13, 2021 18:34

Merge branch 'develop' into thomas/features/seleniumUpdate

9ca468b

Panquesito7 approved these changes Aug 13, 2021

View reviewed changes

Thomas-Boi merged commit 08aa325 into develop Aug 13, 2021

Panquesito7 deleted the thomas/features/seleniumUpdate branch August 13, 2021 19:43

Thomas-Boi mentioned this pull request Aug 14, 2021

Build preparation for release v2.13.0 #811

Merged

amacado mentioned this pull request Aug 14, 2021

Release v2.13.0 #812

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: Peek and Build-Bot Upgrade #806

Feature: Peek and Build-Bot Upgrade #806

Thomas-Boi commented Aug 12, 2021

amacado left a comment

Panquesito7 left a comment

Panquesito7 Aug 13, 2021

Panquesito7 Aug 13, 2021

Panquesito7 Aug 13, 2021

Thomas-Boi Aug 13, 2021

Thomas-Boi commented Aug 13, 2021

Panquesito7 left a comment

Thomas-Boi commented Aug 13, 2021

	print("Creating the release message by querying GitHub API...")
	print("Creating the release message by querying the GitHub API...")

	Thank you for contributing to Devicon! I hope that your icons are accepted into the repo.
	Thank you for contributing to Devicon! I hope that your icons are accepted into the repository.

	// recall that devicon-alias.scss imported the devicon-icomoon.css => don't need
	// recall that devicon-alias.scss imported the devicon-base.css => don't need

Feature: Peek and Build-Bot Upgrade #806

Feature: Peek and Build-Bot Upgrade #806

Conversation

Thomas-Boi commented Aug 12, 2021

amacado left a comment

Choose a reason for hiding this comment

Panquesito7 left a comment

Choose a reason for hiding this comment

Panquesito7 Aug 13, 2021

Choose a reason for hiding this comment

Panquesito7 Aug 13, 2021

Choose a reason for hiding this comment

Panquesito7 Aug 13, 2021

Choose a reason for hiding this comment

Thomas-Boi Aug 13, 2021

Choose a reason for hiding this comment

Thomas-Boi commented Aug 13, 2021

Panquesito7 left a comment

Choose a reason for hiding this comment

Thomas-Boi commented Aug 13, 2021