From d47f75c504056e94b0cec19f32eae7b80028d362 Mon Sep 17 00:00:00 2001
From: Thomas Bui <43018778+Thomas-Boi@users.noreply.github.com>
Date: Thu, 25 Feb 2021 05:34:21 -0800
Subject: [PATCH 01/31] Fix issue with "post_peek_screenshot" action failing
when it's not supposed to (#520)
* Change the boolean in post_check_svgs_comment
* Fixed issue where post_peek action would fail randomly
* Fixed post_peek action not acting correctly
* Apply suggestions from code review (change to PR Number)
Co-authored-by: David Leal
Co-authored-by: David Leal
---
.github/workflows/peek_icons.yml | 31 ++++++++++++----------
.github/workflows/post_peek_screenshot.yml | 29 ++++++++++++--------
2 files changed, 35 insertions(+), 25 deletions(-)
diff --git a/.github/workflows/peek_icons.yml b/.github/workflows/peek_icons.yml
index ac5062bdb..20f3455f1 100644
--- a/.github/workflows/peek_icons.yml
+++ b/.github/workflows/peek_icons.yml
@@ -3,7 +3,10 @@ on:
pull_request:
types: [labeled]
jobs:
- build:
+ peek:
+ # four outcomes: successful check and upload,
+ # unsuccessful check (fail due to user),
+ # fail due to system, skipped
name: Peek Icons
if: github.event.label.name == 'bot:peek'
runs-on: windows-2019
@@ -20,6 +23,18 @@ jobs:
python -m pip install --upgrade pip
pip install -r ./.github/scripts/requirements.txt
+ - name: Save the PR number in an artifact
+ shell: bash
+ env:
+ PR_NUM: ${{ github.event.number }}
+ run: echo $PR_NUM > pr_num.txt
+
+ - name: Upload the PR number
+ uses: actions/upload-artifact@v2
+ with:
+ name: pr_num
+ path: ./pr_num.txt
+
- name: Run icomoon_peek.py
env:
PR_TITLE: ${{ github.event.pull_request.title }}
@@ -36,21 +51,9 @@ jobs:
name: screenshots
path: ./screenshots/*.png
- - name: Save the pr num in an artifact
- shell: bash
- env:
- PR_NUM: ${{ github.event.number }}
- run: echo $PR_NUM > pr_num.txt
-
- - name: Upload the pr num
- uses: actions/upload-artifact@v2
- with:
- name: pr_num
- path: ./pr_num.txt
-
- name: Upload geckodriver.log for debugging purposes
uses: actions/upload-artifact@v2
if: failure()
with:
name: geckodriver-log
- path: ./geckodriver.log
\ No newline at end of file
+ path: ./geckodriver.log
diff --git a/.github/workflows/post_peek_screenshot.yml b/.github/workflows/post_peek_screenshot.yml
index 541441f37..0a7a3ae92 100644
--- a/.github/workflows/post_peek_screenshot.yml
+++ b/.github/workflows/post_peek_screenshot.yml
@@ -8,10 +8,16 @@ jobs:
post_screenshots_in_comment:
name: Post the screenshot
runs-on: ubuntu-18.04
+ if: github.event.action == 'completed' && github.event.workflow_run.conclusion != 'skipped'
+ env:
+ # three possible values: 'skipped', 'success', 'failure'
+ # have to print github.event to console to see these values
+ # note: can't use this env variable up in the if statement above for some reason.
+ # I don't think it's an ordering issue cause it seems 'if' is auto evaluate first
+ PEEK_STATUS: ${{ github.event.workflow_run.conclusion }}
steps:
- - name: Check if the trigger run worked. If not, fail the current run.
- if: github.event.workflow_run.conclusion != 'success'
- uses: cutenode/action-always-fail@v1.0.1
+ - name: Check state of last run
+ run: echo $PEEK_STATUS
- name: Download workflow artifact
uses: dawidd6/action-download-artifact@v2.11.0
@@ -21,7 +27,6 @@ jobs:
run_id: ${{ github.event.workflow_run.id }}
- name: Read the pr_num file
- if: success()
id: pr_num_reader
uses: juliangruber/read-file-action@v1.0.0
with:
@@ -29,6 +34,7 @@ jobs:
- name: Upload screenshot of the newly made icons gotten from the artifacts
id: icons_overview_img_step
+ if: env.PEEK_STATUS == 'success' && success()
uses: devicons/public-upload-to-imgur@v2.2.1
with:
path: ./screenshots/new_icons.png
@@ -37,17 +43,15 @@ jobs:
- name: Upload zoomed in screenshot of the newly made icons gotten from the artifacts
id: icons_detailed_img_step
uses: devicons/public-upload-to-imgur@v2.2.1
- if: success()
+ if: env.PEEK_STATUS == 'success' && success()
with:
path: ./screenshots/screenshot_*.png
client_id: ${{secrets.IMGUR_CLIENT_ID}}
- name: Comment on the PR about the result - Success
uses: jungwinter/comment@v1 # let us comment on a specific PR
- if: success()
+ if: env.PEEK_STATUS == 'success' && success()
env:
- OVERVIEW_IMG_MARKDOWN: ${{ fromJSON(steps.icons_overview_img_step.outputs.markdown_urls)[0] }}
- DETAILED_IMGS_MARKDOWN: ${{ join(fromJSON(steps.icons_detailed_img_step.outputs.markdown_urls), '') }}
MESSAGE: |
Hi there,
@@ -71,10 +75,13 @@ jobs:
type: create
issue_number: ${{ steps.pr_num_reader.outputs.content }}
token: ${{ secrets.GITHUB_TOKEN }}
- body: ${{format(env.MESSAGE, env.OVERVIEW_IMG_MARKDOWN, env.DETAILED_IMGS_MARKDOWN)}}
+ body: >
+ ${{ format(env.MESSAGE,
+ fromJSON(steps.icons_overview_img_step.outputs.markdown_urls)[0],
+ join(fromJSON(steps.icons_detailed_img_step.outputs.markdown_urls), '')) }}
- name: Comment on the PR about the result - Failure
- if: failure() || cancelled()
+ if: failure() || env.PEEK_STATUS == 'failure'
uses: jungwinter/comment@v1 # let us comment on a specific PR
env:
MESSAGE: |
@@ -88,7 +95,7 @@ jobs:
- Your icon information has been added to the `devicon.json` as seen [here](https://github.com/devicons/devicon/blob/master/CONTRIBUTING.md#updateDevicon)
- Your PR title follows the format seen [here](https://github.com/devicons/devicon/blob/master/CONTRIBUTING.md#overview)
- Once everything is fixed, I will try. If I still fail (sorry!), the maintainers will investigate further.
+ I will retry once everything is fixed. If I still fail (sorry!) or there are other erros, the maintainers will investigate.
Best of luck,
Peek Bot :relaxed:
From a106b0aa07d2ef8d4a90f0c141a150a7c2023173 Mon Sep 17 00:00:00 2001
From: David Leal
Date: Thu, 25 Feb 2021 13:49:42 -0600
Subject: [PATCH 02/31] new icon: TheAlgorithms (original, original-wordmark,
plain, plain-wordmark)
---
devicon.json | 21 ++++++++
.../thealgorithms-original-wordmark.svg | 53 +++++++++++++++++++
.../thealgorithms/thealgorithms-original.svg | 13 +++++
.../thealgorithms-plain-wordmark.svg | 53 +++++++++++++++++++
icons/thealgorithms/thealgorithms-plain.svg | 13 +++++
5 files changed, 153 insertions(+)
create mode 100644 icons/thealgorithms/thealgorithms-original-wordmark.svg
create mode 100644 icons/thealgorithms/thealgorithms-original.svg
create mode 100644 icons/thealgorithms/thealgorithms-plain-wordmark.svg
create mode 100644 icons/thealgorithms/thealgorithms-plain.svg
diff --git a/devicon.json b/devicon.json
index b5af57657..8c7cc9e04 100644
--- a/devicon.json
+++ b/devicon.json
@@ -2983,6 +2983,27 @@
"color": "#bb2031",
"aliases": []
},
+ {
+ "name": "thealgorithms",
+ "tags": [
+ "organization",
+ "algorithms"
+ ],
+ "versions": {
+ "svg": [
+ "original",
+ "original-wordmark",
+ "plain",
+ "plain-wordmark"
+ ],
+ "font": [
+ "plain",
+ "plain-wordmark"
+ ]
+ },
+ "color": "#00BCB4",
+ "aliases": []
+ },
{
"name": "trello",
"tags": [
diff --git a/icons/thealgorithms/thealgorithms-original-wordmark.svg b/icons/thealgorithms/thealgorithms-original-wordmark.svg
new file mode 100644
index 000000000..f34dc75fa
--- /dev/null
+++ b/icons/thealgorithms/thealgorithms-original-wordmark.svg
@@ -0,0 +1,53 @@
+
+
+
diff --git a/icons/thealgorithms/thealgorithms-original.svg b/icons/thealgorithms/thealgorithms-original.svg
new file mode 100644
index 000000000..a7461fe6a
--- /dev/null
+++ b/icons/thealgorithms/thealgorithms-original.svg
@@ -0,0 +1,13 @@
+
+
+
diff --git a/icons/thealgorithms/thealgorithms-plain-wordmark.svg b/icons/thealgorithms/thealgorithms-plain-wordmark.svg
new file mode 100644
index 000000000..1c27d0eda
--- /dev/null
+++ b/icons/thealgorithms/thealgorithms-plain-wordmark.svg
@@ -0,0 +1,53 @@
+
+
+
diff --git a/icons/thealgorithms/thealgorithms-plain.svg b/icons/thealgorithms/thealgorithms-plain.svg
new file mode 100644
index 000000000..5e594a37a
--- /dev/null
+++ b/icons/thealgorithms/thealgorithms-plain.svg
@@ -0,0 +1,13 @@
+
+
+
From dcb59059bbcfc1efa5599305361bc7b9ba1d03e5 Mon Sep 17 00:00:00 2001
From: David Leal
Date: Thu, 25 Feb 2021 14:17:55 -0600
Subject: [PATCH 03/31] Fix errors reported by GitHub Actions
---
.../thealgorithms-original-wordmark.svg | 30 +++++++++----------
.../thealgorithms/thealgorithms-original.svg | 3 +-
.../thealgorithms-plain-wordmark.svg | 30 +++++++++----------
icons/thealgorithms/thealgorithms-plain.svg | 3 +-
4 files changed, 30 insertions(+), 36 deletions(-)
diff --git a/icons/thealgorithms/thealgorithms-original-wordmark.svg b/icons/thealgorithms/thealgorithms-original-wordmark.svg
index f34dc75fa..f3c9ca19d 100644
--- a/icons/thealgorithms/thealgorithms-original-wordmark.svg
+++ b/icons/thealgorithms/thealgorithms-original-wordmark.svg
@@ -3,48 +3,46 @@
+
Stale pull requests
+
+After a pull request has been open for over 30 days with no activity or response from the author, it'll be automatically marked as stale. We might fork your changes and merge the changes ourselves. Since GitHub tracks contributions by commits, you will be credited.
+
-First of all, thanks for taking the time to contribute! This project can only grow and live by your countless contributions. To keep this project maintable we developed some guidelines for contributions.
+First of all, thanks for taking the time to contribute! This project can only grow and live by your countless contributions. To keep this project maintainable, we have developed some guidelines for our contributors.
Table of Content
@@ -15,6 +15,7 @@ First of all, thanks for taking the time to contribute! This project can only gr
+We are running a Discord server. You can go here to talk, discuss, and more with the maintainers and other people, too. Here's the invitation: https://discord.gg/hScy8KWACQ. If you don't have a GitHub account but want to suggest ideas or new icons, you can do that here in our Discord channel.
+
diff --git a/README.md b/README.md
index 4ac6b4ca8..5ae052df5 100644
--- a/README.md
+++ b/README.md
@@ -161,6 +161,11 @@ Add css rules in your stylesheet
After a pull request has been open for over 30 days with no activity or response from the author, it'll be automatically marked as stale. We might fork your changes and merge the changes ourselves. Since GitHub tracks contributions by commits, you will be credited.
+
Discord server
+
+We are running a Discord server. You can go here to talk, discuss, and more with the maintainers and other people, too. Here's the invitation: https://discord.gg/hScy8KWACQ.
+
+
Go build yourself
Feel free to follow those steps when you want to build the font
diff --git a/docs/assets/css/discord-logo.svg b/docs/assets/css/discord-logo.svg
new file mode 100644
index 000000000..08daae684
--- /dev/null
+++ b/docs/assets/css/discord-logo.svg
@@ -0,0 +1 @@
+
diff --git a/docs/assets/css/style.css b/docs/assets/css/style.css
index 1c1d2ae22..2c4bb129f 100644
--- a/docs/assets/css/style.css
+++ b/docs/assets/css/style.css
@@ -8,6 +8,14 @@ html {
*, *::after, *::before {
box-sizing: inherit; }
+.discord-logo:before {
+ content: "";
+ background-image: url("discord-logo.svg");
+ height: 40px;
+ width: 40px;
+ display: inline-block;
+ background-size: cover;
+}
.icon-brush:before {
content: "\e600"; }
diff --git a/docs/index.html b/docs/index.html
index 98aed9885..8c9dec6b0 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -88,17 +88,20 @@
SVG versions
-
Github Repo
-
If you prefer a local install, you can download all the files on the github repo.
+
GitHub repository
+
If you prefer a local install, you can download all the files on the GitHub repository.
Originally created by Konpa (under MIT License) and
From f75cd3a2ec0417107ccbd110c26c6e3b624a670e Mon Sep 17 00:00:00 2001
From: David Leal
Date: Mon, 22 Mar 2021 12:22:04 -0600
Subject: [PATCH 12/31] Mention that the Discord server is unofficial
---
CONTRIBUTING.md | 1 +
README.md | 1 +
2 files changed, 2 insertions(+)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 133f8133e..89b141f32 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -304,4 +304,5 @@ As an example, let's assume you have created the svgs for Redhat and Amazon Web
Discord server
We are running a Discord server. You can go here to talk, discuss, and more with the maintainers and other people, too. Here's the invitation: https://discord.gg/hScy8KWACQ. If you don't have a GitHub account but want to suggest ideas or new icons, you can do that here in our Discord channel.
+Note that the Discord server is unofficial, and Devicons is still being maintained via GitHub.
diff --git a/README.md b/README.md
index 5ae052df5..c0e6bae1a 100644
--- a/README.md
+++ b/README.md
@@ -164,6 +164,7 @@ After a pull request has been open for over 30 days with no activity or response
Discord server
We are running a Discord server. You can go here to talk, discuss, and more with the maintainers and other people, too. Here's the invitation: https://discord.gg/hScy8KWACQ.
+Note that the Discord server is unofficial, and Devicons is still being maintained via GitHub.
Go build yourself
From 3a9ec673b1a60a12d01083b830fd32e5a618847e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Malte=20J=C3=BCrgens?=
Date: Tue, 23 Mar 2021 20:33:01 +0100
Subject: [PATCH 13/31] new icon: nextjs (original)
---
devicon.json | 32 ++++++++++++++++++++++++++++++++
icons/nextjs/nextjs-original.svg | 1 +
2 files changed, 33 insertions(+)
create mode 100644 icons/nextjs/nextjs-original.svg
diff --git a/devicon.json b/devicon.json
index b5af57657..81273ac45 100644
--- a/devicon.json
+++ b/devicon.json
@@ -2139,6 +2139,38 @@
"color": "#DF234F",
"aliases": []
},
+ {
+ "name": "nextjs",
+ "tags": [
+ "framework"
+ ],
+ "versions": {
+ "svg": [
+ "original"
+ ],
+ "font": [
+ "original",
+ "original-wordmark",
+ "plain",
+ "plain-wordmark"
+ ]
+ },
+ "color": "#000000",
+ "aliases": [
+ {
+ "base": "original",
+ "alias": "original-wordmark"
+ },
+ {
+ "base": "original",
+ "alias": "plain"
+ },
+ {
+ "base": "original",
+ "alias": "plain-wordmark"
+ }
+ ]
+ },
{
"name": "nginx",
"tags": [
diff --git a/icons/nextjs/nextjs-original.svg b/icons/nextjs/nextjs-original.svg
new file mode 100644
index 000000000..60e02ed57
--- /dev/null
+++ b/icons/nextjs/nextjs-original.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
From 2299df84a9fd4fe339aedc3863b564d35ecf8cfd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Malte=20J=C3=BCrgens?=
Date: Tue, 23 Mar 2021 20:52:36 +0100
Subject: [PATCH 14/31] add original and line icons
---
devicon.json | 13 ++++++-------
icons/nextjs/nextjs-line.svg | 1 +
icons/nextjs/nextjs-original-wordmark.svg | 1 +
icons/nextjs/nextjs-original.svg | 2 +-
4 files changed, 9 insertions(+), 8 deletions(-)
create mode 100644 icons/nextjs/nextjs-line.svg
create mode 100644 icons/nextjs/nextjs-original-wordmark.svg
diff --git a/devicon.json b/devicon.json
index 81273ac45..62ac0395f 100644
--- a/devicon.json
+++ b/devicon.json
@@ -2146,27 +2146,26 @@
],
"versions": {
"svg": [
- "original"
+ "original",
+ "line",
+ "original-wordmark"
],
"font": [
"original",
- "original-wordmark",
"plain",
+ "line",
+ "original-wordmark",
"plain-wordmark"
]
},
"color": "#000000",
"aliases": [
- {
- "base": "original",
- "alias": "original-wordmark"
- },
{
"base": "original",
"alias": "plain"
},
{
- "base": "original",
+ "base": "original-wordmark",
"alias": "plain-wordmark"
}
]
diff --git a/icons/nextjs/nextjs-line.svg b/icons/nextjs/nextjs-line.svg
new file mode 100644
index 000000000..ab8fe59c1
--- /dev/null
+++ b/icons/nextjs/nextjs-line.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/icons/nextjs/nextjs-original-wordmark.svg b/icons/nextjs/nextjs-original-wordmark.svg
new file mode 100644
index 000000000..60e02ed57
--- /dev/null
+++ b/icons/nextjs/nextjs-original-wordmark.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/icons/nextjs/nextjs-original.svg b/icons/nextjs/nextjs-original.svg
index 60e02ed57..e73e3cd19 100644
--- a/icons/nextjs/nextjs-original.svg
+++ b/icons/nextjs/nextjs-original.svg
@@ -1 +1 @@
-
\ No newline at end of file
+
\ No newline at end of file
From 41cc0f8d66d71c98ce85453996a6dbff600375c1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Malte=20J=C3=BCrgens?=
Date: Tue, 23 Mar 2021 21:29:51 +0100
Subject: [PATCH 15/31] add newlines
---
icons/nextjs/nextjs-line.svg | 2 +-
icons/nextjs/nextjs-original-wordmark.svg | 2 +-
icons/nextjs/nextjs-original.svg | 2 +-
3 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/icons/nextjs/nextjs-line.svg b/icons/nextjs/nextjs-line.svg
index ab8fe59c1..72f11af45 100644
--- a/icons/nextjs/nextjs-line.svg
+++ b/icons/nextjs/nextjs-line.svg
@@ -1 +1 @@
-
\ No newline at end of file
+
diff --git a/icons/nextjs/nextjs-original-wordmark.svg b/icons/nextjs/nextjs-original-wordmark.svg
index 60e02ed57..d6bf6f06b 100644
--- a/icons/nextjs/nextjs-original-wordmark.svg
+++ b/icons/nextjs/nextjs-original-wordmark.svg
@@ -1 +1 @@
-
\ No newline at end of file
+
diff --git a/icons/nextjs/nextjs-original.svg b/icons/nextjs/nextjs-original.svg
index e73e3cd19..1ec302222 100644
--- a/icons/nextjs/nextjs-original.svg
+++ b/icons/nextjs/nextjs-original.svg
@@ -1 +1 @@
-
\ No newline at end of file
+
From 727ab5a5be6c6217305fc83f2512e95d83ce8f69 Mon Sep 17 00:00:00 2001
From: Thomas Bui
Date: Sun, 28 Mar 2021 21:27:01 -0700
Subject: [PATCH 16/31] Check svg now fails if there's error and updated
CONTRIBUTING
---
.github/workflows/post_check_svgs_comment.yml | 33 +++++++++++--------
CONTRIBUTING.md | 11 ++++++-
2 files changed, 29 insertions(+), 15 deletions(-)
diff --git a/.github/workflows/post_check_svgs_comment.yml b/.github/workflows/post_check_svgs_comment.yml
index cce4eba31..25dcacf68 100644
--- a/.github/workflows/post_check_svgs_comment.yml
+++ b/.github/workflows/post_check_svgs_comment.yml
@@ -35,21 +35,21 @@ jobs:
with:
path: ./svg_err_messages/svg_err_messages.txt
- - name: Comment on the PR about the result - Success
- uses: jungwinter/comment@v1 # let us comment on a specific PR
- if: success() && steps.err_message_reader.outputs.content == '1'
- env:
- MESSAGE: |
- Hi!
- I'm Devicons' SVG-Checker Bot and everything looks great. Good job!
+ # - name: Comment on the PR about the result - Success
+ # uses: jungwinter/comment@v1 # let us comment on a specific PR
+ # if: success() && steps.err_message_reader.outputs.content == '1'
+ # env:
+ # MESSAGE: |
+ # Hi!
+ # I'm Devicons' SVG-Checker Bot and everything looks great. Good job!
- Have a nice day,
- SVG-Checker Bot :grin:
- with:
- type: create
- issue_number: ${{ steps.pr_num_reader.outputs.content }}
- token: ${{ secrets.GITHUB_TOKEN }}
- body: ${{ env.MESSAGE }}
+ # Have a nice day,
+ # SVG-Checker Bot :grin:
+ # with:
+ # type: create
+ # issue_number: ${{ steps.pr_num_reader.outputs.content }}
+ # token: ${{ secrets.GITHUB_TOKEN }}
+ # body: ${{ env.MESSAGE }}
- name: Comment on the PR about the result - SVG Error
uses: jungwinter/comment@v1 # let us comment on a specific PR
@@ -79,6 +79,11 @@ jobs:
token: ${{ secrets.GITHUB_TOKEN }}
body: ${{ format(env.MESSAGE, steps.err_message_reader.outputs.content) }}
+ # if we posted error messages before, we fail this entire workflow
+ - name: Fail workflow is there is an error.
+ uses: cutenode/action-always-fail@v1.0.1
+ if: success() && (steps.err_message_reader.outputs.content != '0' && steps.err_message_reader.outputs.content != '1')
+
- name: Comment on the PR about the result - Failure
uses: jungwinter/comment@v1 # let us comment on a specific PR
if: failure()
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 89b141f32..f0b37fa39 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -29,7 +29,7 @@ First of all, thanks for taking the time to contribute! This project can only gr
Overview on Submitting Icons
-
Here is an overview of what you have to do to submit your icons to the repo.
+
Here is what you have to do to submit your icons to the repo.
Put the svgs of each Icon into its own folders in /icons
@@ -44,6 +44,15 @@ First of all, thanks for taking the time to contribute! This project can only gr
Versions and Naming Conventions
+
For the technology name, make the file and folder name lowercase and concatenate them. For example:
+
+
AngularJS becomes angularjs or just angular
+
Amazon Web Services becomes amazonwebservices
+
Microsoft SQL Server becomes microsoftsqlserver
+
Note:For JS libraries, you can also remove the "js" part if it's still recognizable.
+
+
+
Each icon/svg can come in different versions. So far, we have:
original: the original logo. Can contain multiple colors. Example
From d68dcf9f6e71b813d3656736c84fc7bead9fbf93 Mon Sep 17 00:00:00 2001
From: Thomas Bui
Date: Sun, 28 Mar 2021 21:34:00 -0700
Subject: [PATCH 17/31] Updated CONTRIBUTING for naming convention
---
CONTRIBUTING.md | 14 ++++++--------
1 file changed, 6 insertions(+), 8 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f0b37fa39..e3afaf9e9 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -22,9 +22,10 @@ First of all, thanks for taking the time to contribute! This project can only gr
Terms
Here are some terms that we will use in this repo:
-
"Icon" refers to the set of svgs/icons of a technology/tool. Ex: We might refer to the React svgs and React icons as the React Icon
-
"SVG/.svg" refers to the svg versions of the Icons.
-
"icons" (lowercase) refers to the font icon versions of the Icons.
+
"Technology" is used to describe a software, libraries, tool, etc...
+
"Icon" refers to the svgs and icons version of a technology as a whole.
+
"SVG/svg" refers to the svg versions of the Icons.
+
"icon" (lowercase) refers specficially to the font icon versions of the Icons.
@@ -49,9 +50,7 @@ First of all, thanks for taking the time to contribute! This project can only gr
AngularJS becomes angularjs or just angular
Amazon Web Services becomes amazonwebservices
Microsoft SQL Server becomes microsoftsqlserver
-
Note:For JS libraries, you can also remove the "js" part if it's still recognizable.
-
Each icon/svg can come in different versions. So far, we have:
@@ -75,7 +74,6 @@ First of all, thanks for taking the time to contribute! This project can only gr
Some icons are really simple (ex. Apple), so the original version can be used as the plain version and as the icon font. In this case, you'll only need to make one of the version (either "original" or "plain"). You can then add an alias in the devicon.json so they can be found with either the "original" or "plain" naming convention. Note: this only applies to font icon versions only, not the SVG versions.
-
@@ -84,7 +82,7 @@ First of all, thanks for taking the time to contribute! This project can only gr
Before you submit your logos/svgs, please ensure that they meet the following standard:
The background must be transparent.
-
The svg name follows this convention: (Icon name)-(original|plain|line)(-wordmark?).
+
The svg name follows this convention: (Technology name)-(original|plain|line)(-wordmark?).
The plain and line versions (with or without wordmark) need to stay as simple as possible. They must have only one color and the paths are united. We will strip the color when turning it into icons so they can have any color.
Optimize/compress your SVGs. You can use a service like compressor or SVG Editor.
@@ -92,7 +90,7 @@ First of all, thanks for taking the time to contribute! This project can only gr
Each .svg file contains one version of an icon in a 0 0 128 128 viewbox. You can use a service like resize-image for scaling the svg.
The svg element does not need the height and width attributes. However, if you do use it, ensure their values are either "128" or "128px". Ex: height="128"
Each .svg must use the fill attribute instead of using classes for colors. See here for more details.
-
The naming convention for the svg file is the following: (Icon name)-(original|plain|line)(-wordmark?).
+
The naming convention for the svg file is the following: (Technology name)-(original|plain|line)(-wordmark?).
Release strategy, conventions, preparation and execution
+
Release strategy
+
Devicon does not follow a strict release plan. A new release is depended on current amount of contributions, required bugfixes/patches and will be discussed by the team of maintainers.
+
Generally speaking: A new release will be published when new icons are added or a bug was fixed. When it's predictable that multiple icons are added in a foreseeable amount of time they are usually wrapped together.
+
Conventions
+
The version naming follows the rules of Semantic Versioning. Given a version number MAJOR.MINOR.PATCH, increment the:
+
+
MAJOR version when you make incompatible API changes,
+
MINOR version when you add functionality (like a new icon) in a backwards compatible manner, and
+
PATCH version when you make backwards compatible bug fixes.
+
+
Release preparation and execution
+
+
Define the next release version number based on the conventions
+
Checkout development as draft-release branch
+
Bump the package version using npm version vMAJOR.MINOR.PATCH -m "bump npm version to vMAJOR.MINOR.PATCH" (see #487)
+
Push the branch draft-release
+
Manually trigger the workflow build_icons.yml (which has a workflow_dispatch event trigger) and select the branch draft-release as target branch. This will build a font version of all icons using icomoon and automatically creates a pull request to merge the build result back into draft-release
+
Review and approve the auto-create pull request created by the action of the step above
+
Create a pull request towards development. Mention the release number in the pull request title and add information about all new icons, fixes, features and enhancements in the description of the pull request. It's also a good idea to mention and thank all contributions who participated in the release (take description of #504 as an example).
+
Wait for review and approval of the pull request (DON'T perform a squash-merge)
+
Once merged create a pull request with BASE master and HEAD development. Copy the description of the earlier pull request.
+
Since it was already approved in the 'development' stage a maintainer is allowed to merge it (DON'T perform a squash-merge).
+
Create a new release using vMAJOR.MINOR.PATCH as tag and release title. Use the earlier created description as description of the release.
+
Publishing the release will trigger the npm_publish.yml workflow which will execute a npm publish leading to a updated npm package (vMAJOR.MINOR.PATCH).
+
\ No newline at end of file
From ea545712ad86a57c6ea316f125ed292d09b36b2a Mon Sep 17 00:00:00 2001
From: Amacado
Date: Fri, 9 Apr 2021 11:24:35 +0200
Subject: [PATCH 26/31] rename the branch created by the workflow and set the
base branch to the same branch which executed the action
---
.github/workflows/build_icons.yml | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/.github/workflows/build_icons.yml b/.github/workflows/build_icons.yml
index f4ebb5297..82016449e 100644
--- a/.github/workflows/build_icons.yml
+++ b/.github/workflows/build_icons.yml
@@ -65,8 +65,7 @@ jobs:
Adios,
Build Bot :sunglasses:
with:
- branch: 'master-build-result'
- base: 'master'
+ branch: 'bot/build-result'
commit-message: 'Built new icons, icomoon.json and devicon.css'
title: 'bot:build new icons, icomoon.json and devicon.css'
body: ${{ format(env.MESSAGE, fromJSON(steps.imgur_step.outputs.imgur_urls)[0] ) }}
From e58e3c34a65259267a64aa85fd7d8e2a541aba8a Mon Sep 17 00:00:00 2001
From: Amacado
Date: Fri, 9 Apr 2021 11:27:56 +0200
Subject: [PATCH 27/31] add hint to release drafting and fix some html errors
---
CONTRIBUTING.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a14554582..b86006dd9 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -24,7 +24,7 @@ First of all, thanks for taking the time to contribute! This project can only gr
Here are some terms that we will use in this repo:
"Technology" is used to describe a software, libraries, tool, etc...
-
"Icon" refers to the svgs and icons version of a technology as a whole.
+
"Icon" refers to the svgs and icons version of a technology as a whole.
"SVG/svg" refers to the svg versions of the Icons.
"icon" (lowercase) refers specficially to the font icon versions of the Icons.
@@ -312,7 +312,7 @@ As an example, let's assume you have created the svgs for Redhat and Amazon Web
Discord server
We are running a Discord server. You can go here to talk, discuss, and more with the maintainers and other people, too. Here's the invitation: https://discord.gg/hScy8KWACQ. If you don't have a GitHub account but want to suggest ideas or new icons, you can do that here in our Discord channel.
-Note that the Discord server is unofficial, and Devicons is still being maintained via GitHub.
+Note that the Discord server is unofficial, and Devicons is still being maintained via GitHub.
Release strategy, conventions, preparation and execution
@@ -335,7 +335,7 @@ We are running a Discord server. You can go here to talk, discuss, and more with
Push the branch draft-release
Manually trigger the workflow build_icons.yml (which has a workflow_dispatch event trigger) and select the branch draft-release as target branch. This will build a font version of all icons using icomoon and automatically creates a pull request to merge the build result back into draft-release
Review and approve the auto-create pull request created by the action of the step above
-
Create a pull request towards development. Mention the release number in the pull request title and add information about all new icons, fixes, features and enhancements in the description of the pull request. It's also a good idea to mention and thank all contributions who participated in the release (take description of #504 as an example).
+
Create a pull request towards development. Mention the release number in the pull request title and add information about all new icons, fixes, features and enhancements in the description of the pull request. Take the commits as a guideline. It's also a good idea to mention and thank all contributions who participated in the release (take description of #504 as an example).
Wait for review and approval of the pull request (DON'T perform a squash-merge)
Once merged create a pull request with BASE master and HEAD development. Copy the description of the earlier pull request.
Since it was already approved in the 'development' stage a maintainer is allowed to merge it (DON'T perform a squash-merge).