@zenhubhq/svg-icons-copy v1.0.9
SVG Icons
SVG Icons for ZenHub 2
Installing
npm install @zenhubhq/svg-icons-copy
The component can be imported with
import { SvgIconBold } from '@zenhubhq/svg-icons-copy';
Development
Running Storybook
npm run storybook
Creating a build
npm run build
This will clean and build all files into the /dist
folder.
Build in Depth
From Zenhub markdown, needs updated
The build process will run through all svg's in the /svg
folder, and generate corresponding react components in the /generated
folder. This is done within the build script. After each is generated into a react compoennt, we import each of them in our root index.js
file. This file is also generated at build time.
We can then import this file into Zenhub. Webpack will also bundle these files into a CJS build, within dist/index.js
.
Releasing
This project uses semantic releases. These are already handled during the publish process by Jenkins, which will update the patch number.
If there is a need to increase the minor or major version numbers, you can you npx semantic-release
to perform this action.
One a new commit is pushed or merged to master, Jenkins will automatically build and publish an update to our private NPM repo.
Publishing
This is handled automatically by Jenkins. If you need to manually deploy a build, you can do that by doing the following
npm publish
Doc
https://github.com/svg/svgo/blob/master/docs/how-it-works/en.md#1-config
Every plugin has its specific position in the plugins list, and order is important.
See order here https://github.com/svg/svgo/blob/master/.svgo.yml
Using currentColor
because we use both stroke
and fill
depending on the icon or path.