pure/RELEASE.md

109 lines
3.1 KiB
Markdown
Raw Normal View History

2019-07-10 16:18:13 +00:00
# Pure Deployment Checklist
These are the steps formally used to publish a new version of Pure.
For all of these steps, replace `1.0.0` with the correct version!
## Prerequisite
This assumes the following repo's are cloned and `npm` installed:
- https://github.com/pure-css/pure
## First, check everything
- [ ] **Update local Pure to latest from pure-css/pure#master**
2021-04-28 16:42:00 +00:00
```bash
$ cd pure/
$ git pull upstream master
```
2019-07-10 16:18:13 +00:00
- [ ] **Build Pure via `grunt`**
2021-04-28 16:42:00 +00:00
```bash
$ grunt
```
2019-07-10 16:18:13 +00:00
- [ ] **Review all src/.../tests/manual/ files in target environments, including:**
2021-04-28 16:42:00 +00:00
- [ ] IE 11
- [ ] Edge
- [ ] Chrome
- [ ] Firefox
- [ ] Safari
- [ ] iOS 10.x
- [ ] Android 4.x
- [ ] Android 5.x
2019-07-10 16:18:13 +00:00
- [ ] **Review pure-site in target environments with [Pure served locally](https://github.com/pure-css/pure-site/blob/master/README.md#running-with-pure-served-locally)**
2021-04-28 16:42:00 +00:00
- [ ] IE 11
- [ ] Edge
- [ ] Chrome
- [ ] Firefox
- [ ] Safari
- [ ] iOS 10.x
- [ ] Android 4.x
- [ ] Android 5.x
2019-07-10 16:18:13 +00:00
- [ ] **Review HISTORY.md**
2021-04-28 16:42:00 +00:00
https://github.com/pure-css/pure/blob/master/HISTORY.md
2019-07-10 16:18:13 +00:00
2021-04-28 16:42:00 +00:00
Make sure all the major changes since the last release of Pure are reflected in HISTORY.md entries.
2019-07-10 16:18:13 +00:00
## Prepare repos for release
### Pure repo
- [ ] **Bump versions**
2021-04-28 16:42:00 +00:00
It should have already been determined whether this is a minor or patch version release. Update Pure's version number to the new version in the following places. You'll likely be dropping a "-pre" suffix which was in place during the last development cycle. Do not use a "v" in the version (e.g., 1.0.0):
2019-07-10 16:18:13 +00:00
2021-04-28 16:42:00 +00:00
- [ ] package.json
- [ ] HISTORY.md (Update "NEXT")
2019-07-10 16:18:13 +00:00
- [ ] **Build Pure release files via `grunt release`**
2021-04-28 16:42:00 +00:00
Using Grunt, create the release/[version]/pure-[version].tar.gz file:
2019-07-10 16:18:13 +00:00
2021-04-28 16:42:00 +00:00
```bash
$ grunt release
```
2019-07-10 16:18:13 +00:00
2021-04-28 16:42:00 +00:00
**Note:** If the build fails it's for a good reason, most likely because there's code which is not passing CSSLint. We should always fix these issues and never force a release.
2019-07-10 16:18:13 +00:00
## Publish pure to NPM
From the `pure` repo run the following command to publish Pure to NPM. This will ensure `jsdelivr.com` CDN gets the new files.
2019-07-10 16:18:13 +00:00
2021-04-28 16:42:00 +00:00
```bash
2019-07-10 16:18:13 +00:00
npm publish .
```
Verify via https://www.jsdelivr.com/package/npm/purecss
2019-07-10 16:18:13 +00:00
## Draft releases on Github
- [ ] **Draft a new release on [GitHub](https://github.com/pure-css/pure/releases) for all three repos,** using "v" in the version number (e.g., v1.0.0). Drafts are invisible to the public. Once these are published, the repos will be visible, and they will be tagged. **Don't publish them just yet.**
2021-04-28 16:42:00 +00:00
- [ ] **pure**
2019-07-10 16:18:13 +00:00
## Formally publish Pure
Now all our files are out there and everything is looking good.
2019-07-10 16:18:13 +00:00
- [ ] **Publish pure**
2021-04-28 16:42:00 +00:00
From the [pure repo](https://github.com/pure-css/pure/releases), publish the release. This will tag the repo and signal to the public that the new Pure release is complete.
2019-07-10 16:18:13 +00:00
## Spread the word
- [ ] **Write blog post**
- [ ] **Tweet**
## Mark repo as pre-release
- [ ] We should mark the version number of the project (in package.json) as 0.6.1-pre for clarity, so there's no mistaking the leading edge of the project from the last release. Commit those changes and push to master.