Skip to content

Commit

Permalink
v3 README (#857)
Browse files Browse the repository at this point in the history
  • Loading branch information
ileitch authored Dec 27, 2024
1 parent 3ff0a38 commit 8e3ce61
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 62 deletions.
14 changes: 3 additions & 11 deletions .mise/tasks/release
Original file line number Diff line number Diff line change
Expand Up @@ -115,14 +115,6 @@ fi
cd ..
gh release create --latest="${is_latest}" -F .release/release_notes.md "${version}" ".release/${zip_filename}" ".release/${zip_artifactbundle}" ".release/${bazel_zip_filename}"

# Homebrew
if [ $is_latest = false ]; then
echo "Not releasing beta to Homebrew."
else
cd ../homebrew-periphery
cat periphery.rb.template | sed s/__VERSION__/${version}/ | sed s/__SHA256__/${sha256}/ > Casks/periphery.rb
git add Casks/periphery.rb
git commit -m "${version}"
git push origin master
cd ../periphery
fi
echo "Next steps:"
echo "* Update Homebrew formula"
echo "* Update Bazel Central Registry"
13 changes: 12 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,27 @@

##### Breaking

**3.0 is a major breaking change and requires some manual migration, please see the [3.0 Migration Guide](https://github.com/peripheryapp/periphery/wiki/3.0-Migration-Guide).**

- Support for installing via CocoaPods has been removed.
- Removed support for Swift 5.9/Xcode 15.2.
- Periphery is now available directly from Homebrew, and the `peripheryapp/periphery` tap is no longer updated. To migrate run the following:
```
brew remove periphery
brew untap peripheryapp/periphery
brew update
brew install periphery
```

##### Enhancements

- Added support for Swift Testing.

##### Bug Fixes

- None.
- Fix numerous issues where generated code could not be scanned.
- Fix support for Xcode's new folder format.
- Fix cloning private Swift package repositories.

## 2.21.2 (2024-11-01)

Expand Down
Loading

0 comments on commit 8e3ce61

Please sign in to comment.