Skip to content

Commit a0f9e9a

Browse files
YOU54FYOU54F
authored
Merge pull request #107 from YOU54F/chore/release/release_notes
Chore/release/release notes
2 parents fb42954 + fbfd96d commit a0f9e9a

7 files changed

+392
-67
lines changed

‎README.md

+321-14
Large diffs are not rendered by default.

‎packaging/README.md.template

+43-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Pact standalone executables
1+
# Pact Ruby Standalone
22

3-
This package contains the Ruby implementations of the Pact Mock Service, Pact Provider Verifier and Pact Broker Client, packaged with Travelling Ruby so that they can be run from the command line without a Ruby installation.
3+
![Build](https://github.com/pact-foundation/pact-ruby-standalone/workflows/Build/badge.svg)
44

5-
To connect to a Pact Broker that uses custom SSL cerificates, set the environment variable `$SSL_CERT_FILE` or `$SSL_CERT_DIR` to a path that contains the appropriate certificate.
5+
Creates a standalone pact command line executable using the ruby pact implementation and Traveling Ruby
66

77
## Package contents
88

@@ -15,6 +15,40 @@ This version (<%= ENV.fetch('VERSION') %>) of the Pact standalone executables pa
1515
* pact_broker-client gem <%= PactBroker::Client::VERSION %>
1616
* pact-message gem <%= Pact::Message::VERSION %>
1717

18+
Binaries will be extracted into `pact/bin`:
19+
20+
```
21+
./pact/bin/
22+
├── pact
23+
├── pact-broker
24+
├── pactflow
25+
├── pact-message
26+
├── pact-mock-service
27+
├── pact-provider-verifier
28+
└── pact-stub-service
29+
```
30+
31+
## Installation
32+
33+
See the [release page][releases].
34+
35+
[releases]: https://github.com/pact-foundation/pact-ruby-standalone/releases
36+
37+
## Supported Platforms
38+
39+
Ruby is not required on the host platform, Ruby 3.2.2 is provided in the distributable.
40+
41+
| OS | Ruby | Architecture | Supported |
42+
| -------| ------- | ------------ | --------- |
43+
| MacOS | 3.2.2 | x86_64 | ✅ |
44+
| MacOS | 3.2.2 | aarch64 (arm64)| ✅ |
45+
| Linux | 3.2.2 | x86_64 | ✅ |
46+
| Linux | 3.2.2 | aarch64 (arm64)| ✅ |
47+
| Windows| 3.2.2 | x86_64 | ✅ |
48+
| Windows| 3.2.2 | x86 | ✅ |
49+
| Windows| 3.2.2 | aarch64 (arm64)| 🚧 |
50+
51+
🚧 - Tested under emulation mode x86 / x86_64 in Windows on ARM
1852

1953
## Usage
2054

@@ -84,3 +118,9 @@ To connect to a Pact Broker that uses custom SSL cerificates, set the environmen
84118
```
85119
<%= pact_message_usage %>
86120
```
121+
122+
## Troubleshooting
123+
124+
### SSL
125+
126+
To connect to a Pact Broker that uses custom SSL certificates, set the environment variable `$SSL_CERT_FILE` or `$SSL_CERT_DIR` to a path that contains the appropriate certificate.

‎packaging/RELEASE_NOTES.md.template

+22-44
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,59 @@
1+
# Pact standalone executables
12

2-
## Installation
3+
This package contains the Ruby implementations of the Pact Mock Service, Pact Provider Verifier and Pact Broker Client, packaged with Traveling Ruby so that they can be run from the command line without a Ruby installation.
34

4-
| OS | Ruby | Architecture | Supported |
5-
| -------| ------- | ------------ | --------- |
6-
| MacOS | 3.2.2 | x86_64 | ✅ |
7-
| MacOS | 3.2.2 | aarch64 (arm64)| ✅ |
8-
| Linux | 3.2.2 | x86_64 | ✅ |
9-
| Linux | 3.2.2 | aarch64 (arm64)| ✅ |
10-
| Windows| 3.2.2 | x86_64 | ✅ |
11-
| Windows| 3.2.2 | x86 | ✅ |
12-
| Windows| 3.2.2 | aarch64 (arm64)| 🚧 |
5+
## Installation of <PACKAGE_VERSION>
136

14-
15-
### One Line Install (MacOS/Linux - aarch64/x86_64)
16-
17-
note: Gets latest version, see individual platform notes for <PACKAGE_VERSION> release, if looking for an older version
7+
### Linux and MacOS
188

199
```
20-
curl -fsSL https://raw.githubusercontent.com/pact-foundation/pact-ruby-standalone/ruby_3.1.2_upgrade/install.sh | bash
10+
curl -fsSL https://raw.githubusercontent.com/pact-foundation/pact-ruby-standalone/master/install.sh | tag=<PACKAGE_VERSION> bash
2111
```
2212

23-
then
24-
25-
```
26-
cd pact/bin
27-
./pact-mock-service --help start
28-
./pact-provider-verifier --help verify
29-
```
13+
### MacOS
3014

31-
### MacOS x86_64
15+
#### x86_64
3216

3317
```
3418
curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/<TAG_NAME>/pact-<PACKAGE_VERSION>-osx-x86_64.tar.gz
3519
tar xzf pact-<PACKAGE_VERSION>-osx-x86_64.tar.gz
36-
cd pact/bin
37-
./pact-mock-service --help start
38-
./pact-provider-verifier --help verify
3920
```
4021

41-
### MacOS arm64
22+
#### arm64
4223

4324
```
4425
curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/<TAG_NAME>/pact-<PACKAGE_VERSION>-osx-arm64.tar.gz
4526
tar xzf pact-<PACKAGE_VERSION>-osx-arm64.tar.gz
46-
cd pact/bin
47-
./pact-mock-service --help start
48-
./pact-provider-verifier --help verify
4927
```
5028

51-
### Linux x86_64
29+
### Linux
30+
31+
#### x86_64
5232

5333
```
5434
curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/<TAG_NAME>/pact-<PACKAGE_VERSION>-linux-x86_64.tar.gz
5535
tar xzf pact-<PACKAGE_VERSION>-linux-x86_64.tar.gz
56-
cd pact/bin
57-
./pact-mock-service --help start
58-
./pact-provider-verifier --help verify
5936
```
6037

61-
### Linux aarch64
38+
#### arm64
6239

6340
```
6441
curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/<TAG_NAME>/pact-<PACKAGE_VERSION>-linux-arm64.tar.gz
6542
tar xzf pact-<PACKAGE_VERSION>-linux-arm64.tar.gz
66-
cd pact/bin
67-
./pact-mock-service --help start
68-
./pact-provider-verifier --help verify
6943
```
7044

7145
### Windows
7246

73-
Download package, unzip, then run:
74-
75-
You can choose the x86_64 package for 64 bit machines, or the x86 package for 32 bit machines, or if you have issues with the 64 bit.
47+
#### x86_64
7648

7749
```
78-
$ cd pact
79-
$ .\bin\pact-mock-service.bat --help start
80-
$ .\bin\pact-provider-verifier.bat --help verify
50+
curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/<TAG_NAME>/pact-<PACKAGE_VERSION>-windows-x86_64.tar.gz
51+
unzip pact-<PACKAGE_VERSION>-windows-x86_64.tar.gz
52+
```
53+
54+
#### x86
55+
8156
```
57+
curl -LO https://github.com/pact-foundation/pact-ruby-standalone/releases/download/<TAG_NAME>/pact-<PACKAGE_VERSION>-windows-x86.tar.gz
58+
unzip pact-<PACKAGE_VERSION>-windows-x86.tar.gz
59+
```

‎script/prepare-manual-release-in-github-workflow.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ pushd pkg; for file in *.{zip,gz}; do sha1sum -b "$file" > "${file}.checksum"; d
2020
cat pkg/*.checksum > pkg/pact-`cat VERSION`.checksum
2121

2222
bundle exec rake generate_release_notes[$tag]
23-
24-
git add VERSION CHANGELOG.md
23+
cp build/README.md README.md
24+
git add VERSION CHANGELOG.md README.md
2525
git commit -m "chore(release): version ${VERSION}
2626
[ci-skip]"
2727
git tag -a ${tag} -m "chore(release): version ${VERSION}"

‎script/prepare-release-in-github-workflow.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ pushd pkg; for file in *.{zip,gz}; do sha1sum -b "$file" > "${file}.checksum"; d
1818
cat pkg/*.checksum > pkg/pact-`cat VERSION`.checksum
1919

2020
bundle exec rake generate_release_notes[$tag]
21-
22-
git add VERSION CHANGELOG.md
21+
cp build/README.md README.md
22+
git add VERSION CHANGELOG.md README.md
2323
git commit -m "chore(release): version ${version}
2424
[ci-skip]"
2525
git tag -a ${tag} -m "chore(release): version ${version}"

‎script/release.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ git commit -m "chore(release): version ${VERSION}
1414
git push origin master
1515
TAG="v${VERSION}"
1616
git tag -a ${TAG} -m "chore(release): version ${VERSION}" && git push origin ${TAG}
17-
echo "Releasing from https://travis-ci.org/pact-foundation/pact-ruby-standalone"
17+
echo "Releasing from https://github.com/pact-foundation/pact-ruby-standalone"

‎tasks/release.rake

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ task :generate_release_notes, [:tag] do | t, args |
1919
release_notes_content = release_notes_template.gsub("<TAG_NAME>", tag)
2020
release_notes_content = release_notes_content.gsub("<PACKAGE_VERSION>", VERSION)
2121
File.open(RELEASE_NOTES_PATH, "w") do |file|
22-
file << readme_content
2322
file << release_notes_content
23+
file << readme_content
2424
end
2525
end
2626

0 commit comments

Comments
 (0)