You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-27Lines changed: 21 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,18 +6,17 @@
6
6
7
7
**[GitHub Action](https://github.com/features/actions) that installs [Hoverfly](https://docs.hoverfly.io/), so that it can be used in subsequent steps in your GitHub Actions CI/CD pipeline (e.g. when running tests that use Hoverfly).**
8
8
9
-
10
9
## Using the Hoverfly action
11
10
12
11
Using this action is as simple as:
13
12
14
13
1.**create a `.github\workflows` directory** in your repository
## Runner GitHub Workspace path and Hoverfly installation location
90
90
91
91
As per the above examples, you have to provide the following parameter:
@@ -100,12 +100,11 @@ The Hoverfly binaries are installed at `${{ github.workspace }}/bin`
100
100
101
101
(The [GitHub workspace directory is persistent throughout the GitHub Action workflow](https://docs.github.com/en/actions/reference/virtual-environments-for-github-hosted-runners#filesystems-on-github-hosted-runners), which means that the binaries are available to any subsequent workflow steps.)
102
102
103
-
104
103
## Enabling HTTPS Hoverfly simulations
105
104
106
105
To enable [HTTPS Hoverfly simulations](https://docs.hoverfly.io/en/latest/pages/tutorials/basic/https/https.html), follow this example:
107
106
108
-
```
107
+
```yml
109
108
steps:
110
109
- name: Install Hoverfly
111
110
uses: agilepathway/hoverfly-github-action@main
@@ -115,33 +114,28 @@ To enable [HTTPS Hoverfly simulations](https://docs.hoverfly.io/en/latest/pages/
115
114
run: install-and-trust-hoverfly-default-cert.sh
116
115
```
117
116
118
-
This script
117
+
This script
119
118
[installs and trusts the default Hoverfly certificate](https://docs.hoverfly.io/en/latest/pages/tutorials/advanced/configuressl/configuressl.html),
120
-
after which you can go ahead and simulate HTTPS calls (see
in the [end-to-end tests](.github/workflows/tests.yml)).
123
122
124
123
Our Hoverfly GitHub Action automatically makes this https cert
125
124
[install script](./install-and-trust-hoverfly-default-cert.sh) available
126
125
(in the same `${{ github.workspace }}/bin` directory which we add to the path and which the
127
126
Hoverfly binaries are located in too).
128
127
129
-
130
-
131
-
132
128
## Tests / examples
133
129
134
130
The [tests](.github/workflows/tests.yml) contain further configuration examples.
135
131
136
-
137
132
## Suggestions / bug reports / contributions
138
133
139
134
The project is [open source](https://opensource.guide/how-to-contribute/) and all contributions are very welcome :slightly_smiling_face: :boom: :thumbsup:
140
135
141
-
*[How to report a bug or suggest a new feature](CONTRIBUTING.md#how-to-report-a-bug-or-suggest-a-new-feature)
142
-
143
-
*[How to make a contribution](CONTRIBUTING.md#how-to-make-a-contribution)
136
+
- [How to report a bug or suggest a new feature](CONTRIBUTING.md#how-to-report-a-bug-or-suggest-a-new-feature)
144
137
138
+
- [How to make a contribution](CONTRIBUTING.md#how-to-make-a-contribution)
0 commit comments