Skip to content

Commit

Permalink
Bump version, Changelog and README for release.
Browse files Browse the repository at this point in the history
  • Loading branch information
hainesr committed Apr 8, 2024
1 parent 385ebd0 commit 0001864
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 8 deletions.
12 changes: 12 additions & 0 deletions Changelog.md
@@ -1,5 +1,17 @@
# X.X.X (Next)

# 2.4

- Ensure compatibility with `--enable-frozen-string-literal`.
- Ensure `File.open_buffer` doesn't rewrite unchanged data. This is a backport of the fix on the 3.x branch.
- Enable use of the version 3 calling style (mainly named parameters) wherever possible, while retaining version 2.x compatibility.
- Add (switchable) warning messages to methods that are changed or removed in version 3.x.

Tooling:

- Switch to using GitHub Actions (from Travis).
- Update Rubocop versions and configuration.

# 2.3.2 (2021-07-05)

- This is a dummy release to warn about breaking changes coming in version 3.0. This updated version uses the Gem `post_install_message` instead of printing to `STDERR`.
Expand Down
22 changes: 15 additions & 7 deletions README.md
Expand Up @@ -9,18 +9,26 @@ Rubyzip is a ruby library for reading and writing zip files.

## Important note

The Rubyzip interface has changed!!! No need to do `require "zip/zip"` and `Zip` prefix in class names removed.
Rubyzip 2.4 is intended to be the last release in the 2.x series. Please get ready for version 3.0.

If you have issues with any third-party gems that require an old version of rubyzip, you can use this workaround:
### Updating to version 3.0

```ruby
gem 'rubyzip', '>= 1.0.0' # will load new rubyzip version
gem 'zip-zip' # will load compatibility for old rubyzip API.
```
The public API of some classes has been modernized to use named parameters for optional arguments. Also some methods have been changed or removed. Please check your usage of the following Rubyzip classes:
* `File`
* `Entry`
* `InputStream`
* `OutputStream`
* `DOSTime`

**Please see [Updating to version 3.x](https://github.com/rubyzip/rubyzip/wiki/Updating-to-version-3.x) in the wiki for details.**

## Requirements

- Ruby 2.4 or greater (for rubyzip 2.0; use 1.x for older rubies)
Version 3.x requires at least Ruby 3.0.

Version 2.x requires at least Ruby 2.4, and is known to work on Ruby 3.x.

It is not recommended to use any versions of Rubyzip earlier than 2.3 due to security issues.

## Installation

Expand Down
2 changes: 1 addition & 1 deletion lib/zip/version.rb
@@ -1,3 +1,3 @@
module Zip
VERSION = '2.3.2'
VERSION = '2.4.rc1'
end

0 comments on commit 0001864

Please sign in to comment.