diff --git a/.github_changelog_generator b/.github_changelog_generator new file mode 100644 index 00000000..d0b7a525 --- /dev/null +++ b/.github_changelog_generator @@ -0,0 +1,3 @@ +issues=false +since-tag=3.0.1-beta.8 +future-release=3.0.1 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 599bf62b..8d30a13f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,10 +1,31 @@ -## master - -* Add your own contributions to the next release on the line below this with your name. - -- [performance] Optimization `PINMemoryCache` trim to date. [#252](https://github.com/pinterest/PINCache/pull/252) -- [performance] Optimize `PINMemoryCache` remove objects when receive memory warning notification. [#251](https://github.com/pinterest/PINCache/pull/251) -- [new] Migrated to GitHub Actions for continuous integration. [#259](https://github.com/pinterest/PINCache/pull/259) +# Changelog + +## [3.0.1](https://github.com/Pinterest/PINCache/tree/3.0.1) (2020-08-20) + +[Full Changelog](https://github.com/Pinterest/PINCache/compare/3.0.1-beta.8...3.0.1) + +**Implemented enhancements:** + +- Support Catalyst [\#272](https://github.com/pinterest/PINCache/pull/272) ([cgmaier](https://github.com/cgmaier)) + +**Merged pull requests:** + +- Update PINOperation [\#277](https://github.com/pinterest/PINCache/pull/277) ([garrettmoon](https://github.com/garrettmoon)) +- Fix PINCacheTests compiling in Xcode 12.0b4 [\#276](https://github.com/pinterest/PINCache/pull/276) ([arangato](https://github.com/arangato)) +- Remove BUCK files [\#274](https://github.com/pinterest/PINCache/pull/274) ([adlerj](https://github.com/adlerj)) +- Fix compiling in Xcode 12.0b4 [\#273](https://github.com/pinterest/PINCache/pull/273) ([zacwest](https://github.com/zacwest)) +- Fix the grammar in an assertion failure message [\#270](https://github.com/pinterest/PINCache/pull/270) ([jparise](https://github.com/jparise)) +- Add Carthage for watchOS, fix macOS min deployment target version [\#269](https://github.com/pinterest/PINCache/pull/269) ([dreampiggy](https://github.com/dreampiggy)) +- Remove the unused CI directory [\#265](https://github.com/pinterest/PINCache/pull/265) ([jparise](https://github.com/jparise)) +- Fix up analyze for github CI [\#264](https://github.com/pinterest/PINCache/pull/264) ([garrettmoon](https://github.com/garrettmoon)) +- Use correct class name in NSAssert\(\) messages [\#263](https://github.com/pinterest/PINCache/pull/263) ([jparise](https://github.com/jparise)) +- Check fileURL outside of the locked scope [\#262](https://github.com/pinterest/PINCache/pull/262) ([jparise](https://github.com/jparise)) +- Remove Danger from the project [\#261](https://github.com/pinterest/PINCache/pull/261) ([jparise](https://github.com/jparise)) +- Switch to GitHub Actions for CI [\#259](https://github.com/pinterest/PINCache/pull/259) ([jparise](https://github.com/jparise)) +- Test that the "remove object" blocks are called [\#258](https://github.com/pinterest/PINCache/pull/258) ([jparise](https://github.com/jparise)) +- Discrepancy between Header Comment and Implementation \#trivial [\#257](https://github.com/pinterest/PINCache/pull/257) ([jlaws](https://github.com/jlaws)) +- Optimization `PINMemoryCache` trim to date [\#252](https://github.com/pinterest/PINCache/pull/252) ([kinarobin](https://github.com/kinarobin)) +- Optimize `PINMemoryCache` remove objects when receive memory warning notification [\#251](https://github.com/pinterest/PINCache/pull/251) ([kinarobin](https://github.com/kinarobin)) ## 3.0.1 -- Beta 8 - [fix] Initing PINCache with TTL enabled should enable TTL on PINMemoryCache. [#246](https://github.com/pinterest/PINCache/pull/246) diff --git a/PINCache.podspec b/PINCache.podspec index fa992eff..e1dc9cfb 100644 --- a/PINCache.podspec +++ b/PINCache.podspec @@ -1,6 +1,6 @@ Pod::Spec.new do |s| s.name = 'PINCache' - s.version = '3.0.1-beta.8' + s.version = '3.0.1' s.homepage = 'https://github.com/pinterest/PINCache' s.summary = 'Fast, thread safe, parallel object cache for iOS and OS X.' s.authors = { 'Garrett Moon' => 'garrett@pinterest.com', 'Justin Ouellette' => 'jstn@tumblr.com' } diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 00000000..6e86b11c --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,13 @@ +# Release Process +This document describes the process for a public PINCache release. + +### Preparation +- Install [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator): `sudo gem install github_changelog_generator` +- Generate a GitHub Personal Access Token to prevent running into public GitHub API rate limits: https://github.com/github-changelog-generator/github-changelog-generator#github-token + +### Process +- Run `github_changelog_generator` in PINCache project directory: `github_changelog_generator --token --user Pinterest --project PINCache`. To avoid hitting rate limit, the generator will replace the entire file with just the changes from this version – revert that giant deletion to get the entire new changelog. +- Update `spec.version` within `PINCache.podspec` and the `since-tag` and `future-release` fields in `.github_changelog_generator`. +- Create a new PR with the updated `PINCache.podspec` and the newly generated changelog, add `#changelog` to the PR message so the CI will not prevent merging it. +- After merging in the PR, [create a new GitHub release](https://github.com/Pinterest/PINCache/releases/new). Use the generated changelog for the new release. +- Push to Cocoapods with `pod trunk push`