Skip to content
Merged
Show file tree
Hide file tree
Changes from 11 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
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
# 10.10.1

#### :memo: Documentation
* [#606](https://github.com/primer/primer/pull/606) Fix for Progress Broken Package Link. ([@emilybrick](https://github.com/emilybrick))

#### :house: Internal
* [#608](https://github.com/primer/primer/pull/608) Update releasing docs. ([@shawnbot](https://github.com/shawnbot))

#### Committers: 2
- Emily Brick ([emilybrick](https://github.com/emilybrick))
- Shawn Allen ([shawnbot](https://github.com/shawnbot))

# 10.10.0

#### :rocket: Enhancement
Expand Down
61 changes: 30 additions & 31 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,50 +6,57 @@

1. Go through the tracking PR and make sure everything listed is merged in.

2. To update the change log for your release, click on the details links for the continuous-integration/travis-ci/push build. Expand the `Deploying application` output and copy the change log content. Update the [CHANGELOG.md](https://github.com/primer/primer/blob/master/CHANGELOG.md) file with the change log content from the build.
2. To update the change log for your release, click on the details links for the continuous-integration/travis-ci/push build. Expand the `Deploying application` output and copy the change log content. Update the [CHANGELOG.md](https://github.com/primer/primer/blob/master/CHANGELOG.md) file with the change log content from build

**Note**: the CHANGELOG contents may be hidden within a collapsed section of the Travis logs under `Deploying the application`. Click the ▶ to the left of that section to expand it, then scroll to the bottom of the page, and copy all of the text between the `Unreleased (YYYY-MM-DD)` heading and the exit status message (e.g. `Done. Your build exited with 0.`). You may need to copy _before_ releasing your mouse to prevent Travis from collapsing that section of the logs first.

3. Bump the package versions in your terminal:

```sh
npm run bump
```
```sh
npm run bump
```

4. Run `script/check-versions` to catch any cross-module version mismatches. You may need to update peer dependencies in `primer-popover` and `primer-marketing-buttons`.
4. Run `script/check-versions` to catch any cross-module version mismatches. (This will run on Travis, too.)

5. Test your changes with the latest release candidate version in the appropriate places (styleguide, storybook, github/github).

6. Once the release PR is approved and you've done necessary testing, merge to `master`. This will trigger publishing to npm.

7. Create a new release branch for the next release from `master` and name it `release-<version>`. Please use the following template for the PR description:
7. Create a new release branch for the next release from `master` and name it `release-<version>`. Please use the following template for the PR description, linking to the relevant issues and/or pull requests for each change, and removing irrelevant headings:

```md
# Primer [Major|Minor|Patch] Release

Tracking Issue for next release: 📦 **0.0.0**
Version: 📦 **0.0.0**
Approximate release date: 📆 DD/MM/YY

### Must

- [ ]

### Should

- [ ]
### :boom: Breaking Change
- [ ] Description #

### Could
### :rocket: Enhancement
- [ ] Description #

- [ ]
### :bug: Bug Fix
- [ ] Description #

### :nail_care: Polish
- [ ] Description #

### :memo: Documentation
- [ ] Description #

### :house: Internal
- [ ] Description #

----

### Ship checklist

- [ ] Update CHANGELOG
- [ ] Update `CHANGELOG.md`
- [ ] Run version bump
- [ ] Update primer.github.io
- [ ] Update github/github
- [ ] Update the style guide
- [ ] Update the release tag note
- [ ] Create a [new release](https://github.com/primer/primer/releases/new)
- [ ] Update github/github with released version
- [ ] Update github/styleguide with released version
- [ ] Create a new pull request for the next release

/cc @primer/ds-core
Expand Down Expand Up @@ -79,17 +86,9 @@

#### Update the Style Guide

1. In [github/styleguide](https://github.com/github/styleguide), update `primer` to your newly released version in your terminal:

`npm install primer@latest`

2. Then run: `script/update-primer-docs`.

3. Commit changes, make PR, get it approved, merge! 🚀

#### Update [primer.github.io](primer.github.io)
1. In [github/styleguide](https://github.com/github/styleguide), update `primer` by following [these instructions](https://github.com/github/styleguide/#adding-new-content-from-primer).

1. Edit [index.html](https://github.com/primer/primer.github.io/blob/master/index.html) to include the latest version.
2. Commit your changes, make a pull request, get it approved, and merge! 🚀


#### Publish release tag
Expand Down
4 changes: 2 additions & 2 deletions modules/primer-product/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "5.8.0",
"version": "5.8.1",
"name": "primer-product",
"description": "Primer's product modules",
"homepage": "http://primer.github.io/",
Expand Down Expand Up @@ -36,7 +36,7 @@
"primer-labels": "1.5.11",
"primer-markdown": "3.7.11",
"primer-popover": "0.1.6",
"primer-progress": "0.1.0",
"primer-progress": "0.1.1",
"primer-subhead": "1.0.9",
"primer-support": "4.7.0"
}
Expand Down
8 changes: 4 additions & 4 deletions modules/primer-progress/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Primer / Progress

[![npm version](https://img.shields.io/npm/v/primer-progress-bar.svg)](https://www.npmjs.org/package/primer-progress-bar)
[![npm version](https://img.shields.io/npm/v/primer-progress.svg)](https://www.npmjs.org/package/primer-progress)
[![Build Status](https://travis-ci.org/primer/primer.svg?branch=master)](https://travis-ci.org/primer/primer)

> Use Progress components to visualize task completion
Expand Down Expand Up @@ -35,11 +35,11 @@ $ npm run build
## Documentation

<!-- %docs
title: Progress Bar
status: Experimental
title: Progress
status: New Release
-->

Use progress bars to show progress.
Use Progress components to visualize task completion.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ugh @emilybrick we needed to do it here, too. The blockquote at the top of the file is ignored; it's the text in the <!-- %docs --> comment "block" that gets pulled into the style guide. 🤦‍♂️


## Default Progress

Expand Down
4 changes: 2 additions & 2 deletions modules/primer-progress/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "0.1.0",
"version": "0.1.1",
"name": "primer-progress",
"description": "Use Progress components to visualize task completion",
"homepage": "http://primer.github.io/",
Expand All @@ -17,7 +17,7 @@
"style": "build/build.css",
"sass": "index.scss",
"main": "build/index.js",
"repository": "https://github.com/primer/primer/tree/master/modules/primer-progress-bar",
"repository": "https://github.com/primer/primer/tree/master/modules/primer-progress",
"bugs": {
"url": "https://github.com/primer/primer/issues"
},
Expand Down
6 changes: 3 additions & 3 deletions modules/primer/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "10.10.0",
"version": "10.10.1",
"name": "primer",
"description": "Primer is the CSS framework that powers GitHub's front-end design. primer includes 23 packages that are grouped into 3 core meta-packages for easy install. Each package and meta-package is independently versioned and distributed via npm, so it's easy to include all or part of Primer within your own project.",
"homepage": "http://primer.github.io/",
Expand Down Expand Up @@ -53,8 +53,8 @@
"primer-page-sections": "1.5.1",
"primer-pagination": "1.0.5",
"primer-popover": "0.1.6",
"primer-product": "5.8.0",
"primer-progress": "0.1.0",
"primer-product": "5.8.1",
"primer-progress": "0.1.1",
"primer-subhead": "1.0.9",
"primer-support": "4.7.0",
"primer-table-object": "1.4.11",
Expand Down