gridicons - npm Package Compare versions
Comparing version 2.0.4 to 2.0.5
| _The versioning refers to the React component build._ | ||
| #### v2.0.5 (2017-10-16) | ||
| * Icon updated: "Reply", flipped direction so it is pointing down and to the right. | ||
| #### v2.0.4 (2017-09-20) | ||
@@ -4,0 +7,0 @@ * Icon added: "Gift" |
| { | ||
| "name": "gridicons", | ||
| "version": "2.0.4", | ||
| "version": "2.0.5", | ||
| "main": "build/index.js", | ||
@@ -5,0 +5,0 @@ "scripts": { |
@@ -7,7 +7,7 @@ # Gridicons | ||
| Note that this component requires [react](https://www.npmjs.com/package/react) to be installed in your project. | ||
| Note that this component requires [react](https://www.npmjs.com/package/react) to be installed in your project. If you don't want to use React, you can simply include the raw `.svg` files from the [`svg-min`](https://github.com/Automattic/gridicons/tree/master/svg-min) folder. | ||
| Gridicon renders a single svg icon based on an `icon` prop. It takes a size property but defaults to 24px. For greater sharpness, the icons should only be shown at either 18px, 24px, 36px or 48px. | ||
| There's a gallery with all the available icons in http://automattic.github.io/gridicons/.. | ||
| There's a gallery with all the available icons in http://automattic.github.io/gridicons/. | ||
@@ -64,3 +64,3 @@ ``` | ||
| 1. Make sure you have a updated local clone of the repository. | ||
| 2. Draw the icon in Illustrator on a 24px grid using the guidelines above (use [icon-template.ai](https://github.com/Automattic/gridicons/wiki/Icon-Template) as starting point). | ||
| 2. Draw the icon in Illustrator on a 24px grid using the guidelines above (use [icon-template.ai](https://github.com/Automattic/gridicons/wiki/Icon-Template) as starting point). | ||
| _Tip: tap CMD + Option + Y in Illustrator to see the pixel grid version._ | ||
@@ -87,13 +87,19 @@ 3. Submit a Pull Request with the icon as a SVG file (inside the `sources/svg` folder), make sure to include a screenshot, ideally containing side by side comparison with some other Gridicons as a visual reference. | ||
| ### Publishing to NPM | ||
| ## Publishing to npm | ||
| - Follow install instructions | ||
| - Check in changes if any and follow PR process. | ||
| - Bump package version in package.json to the next desired version and add an alpha postfix `1.1.0-alpha.1` | ||
| - While testing changes publish using the next tag `npm publish --tag next` | ||
| - If changes look good remove postfix in the version `1.1.0` | ||
| - Publish using the latest tag `npm publish --tag latest` | ||
| Note: to proceed with this you need to have write authorization to npm. | ||
| 1. Create a new PR with updated `CHANGELOG.md` and updated version in `package.json` (i.e. `1.2.3-alpha.1`), see an example [here](https://github.com/Automattic/gridicons/pull/247). | ||
| 2. Pre-publish that PR branch on npm with `npm publish --tag next` ([more info](https://docs.npmjs.com/cli/dist-tag)). | ||
| 3. Create a new update PR in a repository that makes use of Gridicons and run `npm install gridicons@next --save` (which will update `packages.json`). If you're creating the PR in [Calypso](https://github.com/Automattic/wp-calypso) and you get warnings, it might need to regenerate the shrinkwrap, in which case run `npm run update-deps`. See an example [here](https://github.com/Automattic/wp-calypso/pull/17601). | ||
| 4. Test if the new icons show up, and there are no regressions in the previous icons. | ||
| 5. If changes look good, remove the alpha postfix in the version (i.e. `1.2.3-alpha.1` to `1.2.3`) on both repositories PRs. | ||
| 6. Merge the Gridicons PR. | ||
| 7. Tag the release on GitHub: `git tag -a v1.2.3 -m "Release v1.2.3"` (and push `git push origin v1.2.3`). | ||
| 8. Check if it shows up in the [Releases list](https://github.com/Automattic/gridicons/releases). | ||
| 8. Publish to MASTER using the latest tag `npm publish`. | ||
| 9. Merge the update PR in the other repository. | ||
| ## License | ||
| Gridicons is licensed under [GNU General Public License v2 (or later)](./LICENSE.md). |
Sorry, the diff of this file is too big to display
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.89%
136013
- Number of lines in readme file
- increased by6.19%
103
No dependency changes