Merge branch 'master' into fix-alignment

primer · Dec 7, 2020 · 71987db · 71987db
2 parents 089c300 + 270b98f
commit 71987db
Show file tree

Hide file tree

Showing 46 changed files with 5,033 additions and 2,380 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -60,7 +60,7 @@ Use GitHub to [create a pull request](https://help.github.com/en/desktop/contrib
 
 If everything looks good, a maintainer will approve and merge the pull request when appropriate. After the pull request is merged, your icon will be available in the next Octicons release.
 
-## Releasing changes
+## Releasing changes 
 
 Once submitted changes have been agreed upon, these instructions will guide maintainers through releasing changes.
 
@@ -70,22 +70,41 @@ Once submitted changes have been agreed upon, these instructions will guide main
 git checkout -b release-x.y.z
 ```
 
-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. Fixing an icon would be considered a patch. Reach out in the #design-systems Slack channel if you're unsure.
+In the context of Octicons, the version number is updated as follows:
+
+- Breaking changes to the library or workflow, renaming or removing an icon would all be considered a **major update**. 
+- Adding a new icon would be considered a **minor update**.
+- Fixing an icon would be considered a **patch**.
+
+Reach out in the #design-systems Slack channel if you're unsure.
 
 ### 2. Update the [CHANGELOG](https://github.com/primer/octicons/blob/master/CHANGELOG.md) describing the changes in this release.
 
-### 3. Once the CHANGELOG has been updated, run `npm version <new-version>`.
+When adding changes, be sure to provide a link to any of the relevant PRs merged into the release. 
+
+### 3. Update the version in code base
+
+Find and replace the version number of the current release with the version number of the new release. Exclude anything that does relate directly to the Octicons version. Examples of excluded items include `yargs-parser` and `testing-library_react`.
+
+### 4. Create a release PR
+
+When creating the release PR, include the changes written in the CHANGELOG in the description. We advise changing any bulleted item into a checkbox item. After each update is merged into the release PR, check each item as complete.
+
+### 5. Merge
+When all of the checks have passed and the release PR has been approved, merge the new release to the main branch.
 
-This will update `package.json` with the new version, then update all the `lib/*` packages with the same version. If that runs smoothly, it should commit the changed files.
+### 6. Draft new release
+- On the **Code** tab, click **Releases** in the repo sidebar.
+- Click **Draft a new release**.
+- Tag the release with the new version number (e.g. `v10.1.0`).
+- Title the release with the new version number and paste in the changes that were added to the CHANGELOG.
+- Click **Publish release**.
 
-### 4. Push your branch and open a pull request into `master`.
+**Example:**
 
-A GitHub action will automatically publish a canary release of each Octicons package for each commit pushed to a branch. If the branch is prefixed with `release-` it will publish a release candidate.
+![image](https://user-images.githubusercontent.com/10384315/91103190-c6171e80-e61f-11ea-8396-7138996cff30.png)
 
-### 5. Merge feature branches into the release branch
 
-Merge any pull requests you want to include in the release into the release branch (e.g. `add-new-icon` → `release-1.2.3`).
+🎉 Congratulations! The new release has been published.
 
-### 6. Merge the release branch
 
-Shortly after the release branch is merged into `master`, a GitHub action will publish new versions of each Octicons package.
diff --git a/.github/ISSUE_TEMPLATE/icon-request.md b/.github/ISSUE_TEMPLATE/icon-request.md
@@ -14,6 +14,10 @@ Describe the metaphor that the icon should visually illustrate.
 
 Provide a link from either GitHub.com or a Figma project file.
 
+### What is the timeline?
+Provide a timeline for when the icon should be implemented.
+
 ### Screenshots
 
 Add any relevant screenshots for extra context.
+
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,43 @@
+# 11.1.0
+### 🚀 New Features
+- `container` (https://github.com/primer/octicons/pull/507)
+- `squirrel` 24px icon (https://github.com/primer/octicons/pull/508)
+
+### 🐛 Fixes
+- Corrected stroke for 24px `smiley` (https://github.com/primer/octicons/pull/509)
+
+
+# 11.0.0
+
+### 💅 Enhancements
+
+- Cache retrieval of Octicon SVG paths (https://github.com/primer/octicons/pull/491)
+
+### 💥 Breaking changes
+
+- Fix 24px icon names https://github.com/primer/octicons/pull/465 (@BenJetson 🙇)
+  - `unverifed-24.svg` → `unverified-24.svg`
+  - `file-symlink-24.svg` → `file-symlink-file-24.svg`
+  - `fire-24.svg` → `flame-24.svg`
+  - `eye-slash-24.svg` → `eye-closed-24.svg`
+- Remove 24px `settings` icon. Use `gear` instead https://github.com/primer/octicons/pull/493
+
+# 10.1.0
+
+### 🚀 New Features
+
+- [`arrow-switch`](https://github.com/primer/octicons/pull/486)
+- [`file-badge`](https://github.com/primer/octicons/pull/464)
+- [`x-circle`, `x-circle-fill`, `circle`](https://github.com/primer/octicons/pull/455)
+
+### 🐛 Fixes
+
+- Corrected positioning for `triangle-down` [#459](https://github.com/primer/octicons/pull/459)
+
+### 🧽Chores
+
+- Dependency updates
+
 # 10.0.0
 
 ## All packages
@@ -46,10 +86,6 @@
 | `request-changes`        | `diff`                    |                                                                                                                                                     |
 | `saved`                  | `bookmark`                |                                                                                                                                                     |
 | `text-size`              | `heading` or `typography` |                                                                                                                                                     |
-| `triangle-down`          | `caret-down`              |                                                                                                                                                     |
-| `triangle-left`          | `caret-left`              |                                                                                                                                                     |
-| `triangle-right`         | `caret-right`             |                                                                                                                                                     |
-| `triangle-up`            | `caret-up`                |                                                                                                                                                     |
 | `unsaved`                | `bookmark-slash`          |                                                                                                                                                     |
 | `watch`                  | `hourglass`               |                                                                                                                                                     |
 | `workflow-all`           |                           | [Request this icon](https://github.com/primer/octicons/issues/new?assignees=&labels=icon+request&template=icon-request.md&title=%5BIcon+request%5D) |