Skip to content

Commit d0509fd

Browse files
committed
Add releases.md.
1 parent 4d1a70b commit d0509fd

File tree

4 files changed

+28
-46
lines changed

4 files changed

+28
-46
lines changed

bake.rb

Lines changed: 8 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,12 @@
11
# frozen_string_literal: true
22

33
# Released under the MIT License.
4-
# Copyright, 2020-2023, by Samuel Williams.
5-
6-
def external
7-
require 'bundler'
8-
9-
Bundler.with_unbundled_env do
10-
clone_and_test("protocol-http1")
11-
clone_and_test("protocol-http2")
12-
clone_and_test("async-websocket")
13-
clone_and_test("async-http")
14-
clone_and_test("async-rest")
15-
clone_and_test("falcon")
16-
end
17-
end
18-
19-
private
20-
21-
def clone_and_test(name)
22-
path = "external/#{name}"
23-
24-
unless File.exist?(path)
25-
system("git", "clone", "https://[email protected]/socketry/#{name}", path)
26-
end
27-
28-
gemfile = [
29-
File.join(path, "gems.rb"),
30-
File.join(path, "Gemfile"),
31-
].find{|path| File.exist?(path)}
32-
33-
system("git", "checkout", "-f", File.basename(gemfile), chdir: path)
34-
35-
File.open(gemfile, "a") do |file|
36-
file.puts('', 'gem "protocol-http", path: "../../"')
37-
end
38-
39-
system("bundle install && bundle exec rspec", chdir: path)
4+
# Copyright, 2024, by Samuel Williams.
5+
6+
# Update the project documentation with the new version number.
7+
#
8+
# @parameter version [String] The new version number.
9+
def after_gem_release_version_increment(version)
10+
context['releases:update'].call(version)
11+
context['utopia:project:readme:update'].call
4012
end

gems.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
gem "bake-gem"
1414

1515
gem "utopia-project", "~> 0.18"
16+
gem "bake-releases"
1617
end
1718

1819
group :test do

readme.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,22 @@ Please see the [project documentation](https://socketry.github.io/protocol-http/
1818

1919
- [Design Overview](https://socketry.github.io/protocol-http/guides/design-overview/index) - This guide explains the high level design of `protocol-http` in the context of wider design patterns that can be used to implement HTTP clients and servers.
2020

21+
## Releases
22+
23+
Please see the [project releases](https://socketry.github.io/protocol-http/releases/index) for all releases.
24+
25+
### Unreleased
26+
27+
## See Also
28+
29+
- [protocol-http1](https://github.com/socketry/protocol-http1) — HTTP/1 client/server implementation using this
30+
interface.
31+
- [protocol-http2](https://github.com/socketry/protocol-http2) — HTTP/2 client/server implementation using this
32+
interface.
33+
- [async-http](https://github.com/socketry/async-http) — Asynchronous HTTP client and server, supporting multiple HTTP
34+
protocols & TLS.
35+
- [async-websocket](https://github.com/socketry/async-websocket) — Asynchronous client and server WebSockets.
36+
2137
## Contributing
2238

2339
We welcome contributions to this project.
@@ -35,13 +51,3 @@ In order to protect users of this project, we require all contributors to comply
3551
### Community Guidelines
3652

3753
This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.
38-
39-
## See Also
40-
41-
- [protocol-http1](https://github.com/socketry/protocol-http1) — HTTP/1 client/server implementation using this
42-
interface.
43-
- [protocol-http2](https://github.com/socketry/protocol-http2) — HTTP/2 client/server implementation using this
44-
interface.
45-
- [async-http](https://github.com/socketry/async-http) — Asynchronous HTTP client and server, supporting multiple HTTP
46-
protocols & TLS.
47-
- [async-websocket](https://github.com/socketry/async-websocket) — Asynchronous client and server WebSockets.

releases.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Releases
2+
3+
## Unreleased

0 commit comments

Comments
 (0)