Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

8.3.0 #273

Merged
merged 11 commits into from
Jan 9, 2019
Merged

8.3.0 #273

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 11 additions & 23 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ Make sure your duplicate file can be viewed by others. In the share menu "Anyone

You can submit a pull request updating the `figma.url` configuration in the root [package.json](https://github.com/primer/octicons/blob/master/package.json#L10) with your figma file. Doing so will generate alpha releases of [all the libraries that distribute Octicons](https://github.com/primer/octicons#libraries).

If an icon was edited or added, you should see the before and after images directly in the PR. In addition, please describe your proposed changes in the PR's description.

Once the build passes on your pull request, you should see statuses with all the alpha versions of the libraries. You can then use these to test your changes.

[Here is an example pull request](https://github.com/primer/octicons/pull/206)
Expand All @@ -40,41 +42,27 @@ Once submitted changes have been agreed upon, these instructions will guide core

## Step 1, Save:

Save the contributor’s figma file as a `.fig` file.
Save the contributor’s Figma file as a `.fig` file and open in Figma (it will automatically be imported into your Drafts)

[<img src="https://user-images.githubusercontent.com/54012/37809888-940f5d38-2e0e-11e8-957f-99c162a1d4ff.gif" width="400"/>](https://user-images.githubusercontent.com/54012/37809888-940f5d38-2e0e-11e8-957f-99c162a1d4ff.gif)

## Step 2, Import:

Drag and drop, or add the file to the main team project. Make sure its name is different from the master Octicons file.

[<img src="https://user-images.githubusercontent.com/54012/37809879-8d9824ee-2e0e-11e8-9b1d-e83316192eb0.gif" width="400"/>](https://user-images.githubusercontent.com/54012/37809879-8d9824ee-2e0e-11e8-9b1d-e83316192eb0.gif)


## Step 3, Publish:

From the new imported file, publish the updated or new components to the team library. This published component makes importing into the master document easier.

[<img src="https://user-images.githubusercontent.com/54012/37807772-6734f926-2e04-11e8-98a0-9b4c73411bd3.gif" width="400"/>](https://user-images.githubusercontent.com/54012/37807772-6734f926-2e04-11e8-98a0-9b4c73411bd3.gif)

## Step 4, Add:
Drag and drop, or paste the updated or new icon from the contributer's file into the main Octicons Figma file. Make sure that the SVG only contains a single `path` and that it has relevant component keywords in Figma.

In the Team Library you will see the new Octicons file, and all the components from that file. Add the new components to the master Octicons file. It makes changing easier if you drag it on top of the icon you are changing.

[<img src="https://user-images.githubusercontent.com/54012/37807775-6b1dea52-2e04-11e8-804a-a41c6bc04fd2.gif" width="400"/>](https://user-images.githubusercontent.com/54012/37807775-6b1dea52-2e04-11e8-804a-a41c6bc04fd2.gif)
## Step 3, Add:

## Step 5, Replace:
Once the new changes have been added the new components to the master Octicons file, you can publish to the team library in Figma.

Right click on the new component instance and select "Detach Instance". Then toggle both the old and new components open. Move the shape from the new component into the old component. Delete the old component’s shape. Delete the empty new component container.

[<img src="https://user-images.githubusercontent.com/54012/37807780-6ddba626-2e04-11e8-9a6b-749ac5b800fe.gif" width="400"/>](https://user-images.githubusercontent.com/54012/37807780-6ddba626-2e04-11e8-9a6b-749ac5b800fe.gif)
## Step 4, Create a Release Branch in Octicons:

## Step 6, Publishing:
After you've published the latest changes in the Figma file, create a release branch in the [Octicons repo](https://github.com/primer/octicons).

Publish the component changes to your team library. You can now delete the imported `.fig` file from the contributor.
Update the [changelog](https://github.com/primer/octicons/blob/master/CHANGELOG.md) with the new changes pertaining to this version.

[<img src="https://user-images.githubusercontent.com/54012/37812350-cc2349ba-2e1c-11e8-8b80-d9ff2f8d4ea3.png" width="600"/>](https://user-images.githubusercontent.com/54012/37812350-cc2349ba-2e1c-11e8-8b80-d9ff2f8d4ea3.png)
Once the changlog has been updated, run `npm run bump`. This will guide you through a prompt asking what all the new versions of the packages should be. In the context of Octicons, significant changes to the library or workflow, or removing an icon would be considered a major update, adding a new icon would be considered a minor update, and fixing an icon would be considered a patch. Reach out in the #design-systems Slack channel if you're unsure!

Create a release branch, and run `npm run bump`. This will guide you through a prompt asking what all the new versions of the packages should be. After, push up your branch and open a pull request into master.
After, push up your branch and open a pull request into master.

[master-octicons]: https://www.figma.com/file/FP7lqd1V00LUaT5zvdklkkZr/Octicons
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# 8.3.0

- New "changes requested" icon https://github.com/primer/octicons/pull/267
- Contrib Doc Updates https://github.com/primer/octicons/pull/256
- Updating licenses to 2019 https://github.com/primer/octicons/pull/272

# 8.2.0

- Add `fold-up` and `fold-down` icons, courtesy of @pmarsceill
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2018 GitHub Inc.
Copyright (c) 2019 GitHub Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
2 changes: 1 addition & 1 deletion lerna.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
"lib/octicons_jekyll",
"lib/octicons_react"
],
"version": "8.2.0"
"version": "8.3.0"
}
2 changes: 1 addition & 1 deletion lib/octicons_gem/LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2018 GitHub Inc.
Copyright (c) 2019 GitHub Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
2 changes: 1 addition & 1 deletion lib/octicons_gem/lib/octicons/version.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module Octicons
VERSION = "8.2.0".freeze
VERSION = "8.3.0".freeze
end
2 changes: 1 addition & 1 deletion lib/octicons_gem/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "octicons_gem",
"version": "8.2.0",
"version": "8.3.0",
"description": "Don't install",
"scripts": {
"postinstall": "bundle install --path vendor/bundle",
Expand Down
2 changes: 1 addition & 1 deletion lib/octicons_helper/LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2018 GitHub Inc.
Copyright (c) 2019 GitHub Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
2 changes: 1 addition & 1 deletion lib/octicons_helper/lib/octicons_helper/version.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module OcticonsHelper
VERSION = "8.2.0".freeze
VERSION = "8.3.0".freeze
end
2 changes: 1 addition & 1 deletion lib/octicons_helper/octicons_helper.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ Gem::Specification.new do |s|

s.require_paths = ["lib"]

s.add_dependency "octicons", "8.2.0"
s.add_dependency "octicons", "8.3.0"
s.add_dependency "rails"
end
4 changes: 2 additions & 2 deletions lib/octicons_helper/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "octicons_helper",
"version": "8.2.0",
"version": "8.3.0",
"description": "A rails helper that makes including svg Octicons simple.",
"scripts": {
"version": "../../script/rubyversion ./lib/octicons_helper/version.rb",
Expand All @@ -22,6 +22,6 @@
"rubygems": "octicons_helper",
"homepage": "https://github.com/primer/octicons#readme",
"dependencies": {
"octicons_gem": "8.2.0"
"octicons_gem": "8.3.0"
}
}
2 changes: 1 addition & 1 deletion lib/octicons_jekyll/LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2018 GitHub Inc.
Copyright (c) 2019 GitHub Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
2 changes: 1 addition & 1 deletion lib/octicons_jekyll/jekyll-octicons.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ Gem::Specification.new do |s|
s.require_paths = ["lib"]

s.add_dependency "jekyll", "~> 3.1"
s.add_dependency "octicons", "8.2.0"
s.add_dependency "octicons", "8.3.0"
end
2 changes: 1 addition & 1 deletion lib/octicons_jekyll/lib/jekyll-octicons/version.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ module Liquid; class Tag; end; end

module Jekyll
class Octicons < Liquid::Tag
VERSION = "8.2.0".freeze
VERSION = "8.3.0".freeze
end
end
4 changes: 2 additions & 2 deletions lib/octicons_jekyll/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "jekyll-octicons",
"version": "8.2.0",
"version": "8.3.0",
"description": "A jekyll liquid plugin that makes including svg Octicons simple.",
"scripts": {
"version": "../../script/rubyversion ./lib/jekyll-octicons/version.rb",
Expand All @@ -21,6 +21,6 @@
"rubygems": "jekyll-octicons",
"homepage": "https://github.com/primer/octicons#readme",
"dependencies": {
"octicons_gem": "8.2.0"
"octicons_gem": "8.3.0"
}
}
2 changes: 1 addition & 1 deletion lib/octicons_node/LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2018 GitHub Inc.
Copyright (c) 2019 GitHub Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
2 changes: 1 addition & 1 deletion lib/octicons_node/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "octicons",
"version": "8.2.0",
"version": "8.3.0",
"description": "A scalable set of icons handcrafted with <3 by GitHub.",
"homepage": "https://octicons.github.com",
"author": "GitHub Inc.",
Expand Down
2 changes: 1 addition & 1 deletion lib/octicons_react/LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2018 GitHub Inc.
Copyright (c) 2019 GitHub Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
4 changes: 2 additions & 2 deletions lib/octicons_react/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@githubprimer/octicons-react",
"version": "8.2.0",
"version": "8.3.0",
"description": "A scalable set of icons handcrafted with <3 by GitHub.",
"homepage": "https://octicons.github.com",
"author": "GitHub, Inc.",
Expand Down Expand Up @@ -45,7 +45,7 @@
"fs-extra": "^6.0.1",
"jest": "^23.2.0",
"next": "^5.1.0",
"octicons": "8.2.0",
"octicons": "8.3.0",
"primer-react": "0.0.6-alpha.1",
"react": "^16.4.0",
"react-dom": "^16.4.1",
Expand Down