Skip to content

Commit c4c872e

Browse files
authored
Merge pull request #333 from devicons/TB_bugFix
Comment Bot temporary bug fix, mocha font fix and build script update
2 parents 34de065 + cc4266e commit c4c872e

4 files changed

Lines changed: 26 additions & 23 deletions

File tree

.github/workflows/build_icons.yml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
name: Build Icons
2-
on:
3-
pull_request:
4-
types: [labeled]
2+
on: workflow_dispatch
53
jobs:
64
build:
75
name: Get Fonts From Icomoon
8-
if: contains(github.event.pull_request.labels.*.name, 'bot:build')
96
runs-on: windows-2019
107
steps:
118
- uses: actions/checkout@v2
@@ -46,7 +43,8 @@ jobs:
4643
uses: peter-evans/create-pull-request@v3
4744
with:
4845
branch: ${{ format('build/{0}', github.head_ref) }}
46+
base: 'develop'
4947
commit-message: 'Built new icons, icomoon.json and devicon.css'
5048
title: 'bot:build new icons, icomoon.json and devicon.css'
5149
body: 'Automated font-building task ran by GitHub Actions bot'
52-
delete-branch: ${{true}}
50+
delete-branch: true

.github/workflows/peek_icons.yml

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,17 @@ jobs:
3838
with:
3939
name: new_icons
4040
path: ./new_icons.png
41-
- name: Comment on the PR about the result
42-
uses: github-actions-up-and-running/pr-comment@v1.0.1
43-
with:
44-
repo-token: ${{ secrets.GITHUB_TOKEN }}
45-
message: >
46-
Hi! I'm Devicons' GitHub Actions Bot!
41+
# - name: Comment on the PR about the result
42+
# uses: github-actions-up-and-running/pr-comment@v1.0.1
43+
# with:
44+
# repo-token: ${{ secrets.GITHUB_TOKEN }}
45+
# message: >
46+
# Hi! I'm Devicons' GitHub Actions Bot!
4747

48-
I just peeked at the icons that you wanted to add and upload them to the
49-
[Actions page](https://github.com/devicons/devicon/actions). The maintainers
50-
will now take a look at it and decide whether to merge your PR.
48+
# I just peeked at the icons that you wanted to add and upload them to the
49+
# [Actions page](https://github.com/devicons/devicon/actions). The maintainers
50+
# will now take a look at it and decide whether to merge your PR.
5151

52-
Cheers :),
53-
Bot
52+
# Cheers :),
53+
54+
# Bot

CONTRIBUTING.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,8 @@ First of all, thanks for taking the time to contribute! This project can only gr
2626
<li>Include the name of the icon in the pull request title. Follow this format: <code>new icon: {{logoName}} ({{versions}})</code> </li>
2727
<li><i>Optional</i>: Add images of the new icon(s) to the description of the pull request. This would help speed up the review process </li>
2828
<li><i>Optional</i>: Reference the issues regarding the new icon. </li>
29-
<li>Wait for a repo maintainer to review your changes. Once they are satisfied, they will <a href="#buildScript">build your repo </a>. This will create a PR into your branch.</li>
30-
<li>Review the PR. It should contain the icon versions of your svgs. Accept the changes if you are satisfied</li>
31-
<li>Once you accept the changes, a maintainer will accept your PR into the repo.</li>
29+
<li>Wait for a repo maintainer to review your changes. They will run a script to check your icons. </li>
30+
<li>If there are no issue, they will accept your PR into the repo. Else, they will let you know and give you a chance to fix it.</li>
3231
</ol>
3332

3433
<hr>
@@ -64,6 +63,8 @@ Some icons are really simple (like the Apple one), so the original version can b
6463
</li>
6564
<li>Optimize/compress your SVGs. You can use a service like <a href="https://compressor.io/">compressor</a> or <a href="https://petercollingridge.appspot.com/svg-editor">SVG Editor</a>.</li>
6665
<li>The icon's strokes and texts must be fills. We use Icomoon to make our icon, which has its<a href="https://icomoon.io/#docs/stroke-to-fill"> requirements</a></li>
66+
<li>Each <code>.svg</code> file contains one version of an icon in a <code>0 0 128 128</code> viewbox</li>
67+
<li>The naming convention for the svg file is the following: <code>(icon name)-(original|plain|line)-(wordmark)</code></li>
6768
</ul>
6869

6970
<hr>
@@ -72,8 +73,6 @@ Some icons are really simple (like the Apple one), so the original version can b
7273
<li>Each icon has its own folder located in the <code>icons</code> folder</li>
7374
<li>Each icon folder contains one <code>.eps</code> file and as many <code>.svg</code> files as versions available</li>
7475
<li>The <code>.eps</code> file contains all available versions of an icon. Each version is contained in a 128px by 128px artboard</li>
75-
<li>Each <code>.svg</code> file contains one version of an icon in a <code>0 0 128 128</code> viewbox</li>
76-
<li>The naming convention for the svg file is the following: <code>(icon name)-(original|plain|line)-(wordmark)</code></li>
7776
</ul>
7877

7978
<hr>
@@ -158,6 +157,7 @@ As an example, let's assume you have created the svgs for Amazon Web Services an
158157
"font": [ // here are the versions that will be used to create icons
159158
"original", // original is simple enough to be used as plain
160159
"plain-wordmark",
160+
// note that the alias "plain" is not listed here. It must be listed in the `aliases` attribute
161161
]
162162
},
163163
"color": "#F7A80D", // note the '#' character
@@ -232,9 +232,13 @@ As an example, let's assume you have created the svgs for Amazon Web Services an
232232
<hr>
233233
<h2 id='buildScript'>Regarding The Build Script</h2>
234234
<p>To make adding icons easier for repo maintainers, we rely on GitHub Actions, Python, Selenium, and Gulp to automate our tasks.</p>
235-
<p>So far, the tasks that we have automated are:</p>
235+
<p>So far, the tasks in the build script are:</p>
236236
<ul>
237237
<li>Upload svgs to <a href="https://icomoon.io/app/#/select">icomoon.io</a> and get the icons back. For details, see <a href="https://github.com/devicons/devicon/issues/252"> the original disscussion</a>, <a href="https://github.com/devicons/devicon/pull/268">this PR that introduce the feature</a> and <a href="https://github.com/devicons/devicon/issues/300">the final changes to it.</a></li>
238238
<li>Build, combine, and minify CSS files. For details, see <a href="https://github.com/devicons/devicon/pull/290">this</a></li>
239+
</ul>
240+
<p>There are also other tasks that we are automating, such as:</p>
241+
<ul>
239242
<li>Ensure code quality is up to standard</li>
243+
<li>Upload svgs to <a href="https://icomoon.io/app/#/select">icomoon.io</a> and take a screenshot for check.
240244
</ul>

icons/mocha/mocha-plain.svg

Lines changed: 1 addition & 1 deletion
Loading

0 commit comments

Comments
 (0)