diff --git a/.github/workflows/build_icons.yml b/.github/workflows/build_icons.yml index 8d333172..2f6e69d1 100644 --- a/.github/workflows/build_icons.yml +++ b/.github/workflows/build_icons.yml @@ -1,11 +1,8 @@ name: Build Icons -on: - pull_request: - types: [labeled] +on: workflow_dispatch jobs: build: name: Get Fonts From Icomoon - if: contains(github.event.pull_request.labels.*.name, 'bot:build') runs-on: windows-2019 steps: - uses: actions/checkout@v2 @@ -46,7 +43,8 @@ jobs: uses: peter-evans/create-pull-request@v3 with: branch: ${{ format('build/{0}', github.head_ref) }} + base: 'develop' commit-message: 'Built new icons, icomoon.json and devicon.css' title: 'bot:build new icons, icomoon.json and devicon.css' body: 'Automated font-building task ran by GitHub Actions bot' - delete-branch: ${{true}} + delete-branch: true diff --git a/.github/workflows/peek_icons.yml b/.github/workflows/peek_icons.yml index 30bacbb9..9f9af857 100644 --- a/.github/workflows/peek_icons.yml +++ b/.github/workflows/peek_icons.yml @@ -38,16 +38,17 @@ jobs: with: name: new_icons path: ./new_icons.png - - name: Comment on the PR about the result - uses: github-actions-up-and-running/pr-comment@v1.0.1 - with: - repo-token: ${{ secrets.GITHUB_TOKEN }} - message: > - Hi! I'm Devicons' GitHub Actions Bot! + # - name: Comment on the PR about the result + # uses: github-actions-up-and-running/pr-comment@v1.0.1 + # with: + # repo-token: ${{ secrets.GITHUB_TOKEN }} + # message: > + # Hi! I'm Devicons' GitHub Actions Bot! - I just peeked at the icons that you wanted to add and upload them to the - [Actions page](https://github.com/devicons/devicon/actions). The maintainers - will now take a look at it and decide whether to merge your PR. + # I just peeked at the icons that you wanted to add and upload them to the + # [Actions page](https://github.com/devicons/devicon/actions). The maintainers + # will now take a look at it and decide whether to merge your PR. - Cheers :), - Bot + # Cheers :), + + # Bot diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c58f6c28..99b60aab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,9 +26,8 @@ First of all, thanks for taking the time to contribute! This project can only gr
  • Include the name of the icon in the pull request title. Follow this format: new icon: {{logoName}} ({{versions}})
  • Optional: Add images of the new icon(s) to the description of the pull request. This would help speed up the review process
  • Optional: Reference the issues regarding the new icon.
    • -
  • Wait for a repo maintainer to review your changes. Once they are satisfied, they will build your repo . This will create a PR into your branch.
    • -
  • Review the PR. It should contain the icon versions of your svgs. Accept the changes if you are satisfied
    • -
  • Once you accept the changes, a maintainer will accept your PR into the repo.
    • +
  • Wait for a repo maintainer to review your changes. They will run a script to check your icons.
    • +
  • 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.
    • @@ -64,6 +63,8 @@ Some icons are really simple (like the Apple one), so the original version can b
  • Optimize/compress your SVGs. You can use a service like compressor or SVG Editor.
  • The icon's strokes and texts must be fills. We use Icomoon to make our icon, which has its requirements
    • +
  • Each .svg file contains one version of an icon in a 0 0 128 128 viewbox
    • +
  • The naming convention for the svg file is the following: (icon name)-(original|plain|line)-(wordmark)
    • @@ -72,8 +73,6 @@ Some icons are really simple (like the Apple one), so the original version can b
  • Each icon has its own folder located in the icons folder
  • Each icon folder contains one .eps file and as many .svg files as versions available
  • The .eps file contains all available versions of an icon. Each version is contained in a 128px by 128px artboard
    • -
  • Each .svg file contains one version of an icon in a 0 0 128 128 viewbox
    • -
  • The naming convention for the svg file is the following: (icon name)-(original|plain|line)-(wordmark)
    • @@ -158,6 +157,7 @@ As an example, let's assume you have created the svgs for Amazon Web Services an "font": [ // here are the versions that will be used to create icons "original", // original is simple enough to be used as plain "plain-wordmark", + // note that the alias "plain" is not listed here. It must be listed in the `aliases` attribute ] }, "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

    Regarding The Build Script

    To make adding icons easier for repo maintainers, we rely on GitHub Actions, Python, Selenium, and Gulp to automate our tasks.

    -

    So far, the tasks that we have automated are:

    +

    So far, the tasks in the build script are:

    +

    There are also other tasks that we are automating, such as:

    + \ No newline at end of file diff --git a/icons/mocha/mocha-plain.svg b/icons/mocha/mocha-plain.svg index 5bc4f484..b62101e7 100644 --- a/icons/mocha/mocha-plain.svg +++ b/icons/mocha/mocha-plain.svg @@ -1 +1 @@ -mocha \ No newline at end of file +mocha \ No newline at end of file