Skip to content

Commit 89a4c8d

Browse files
committed
docs: fix version in the example and remove hard line endings
Signed-off-by: Avi Miller <[email protected]>
1 parent e26e9f7 commit 89a4c8d

File tree

2 files changed

+10
-16
lines changed

2 files changed

+10
-16
lines changed

.github/workflows/test-run-oci-cli-command.yaml

-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@ on:
44
pull_request:
55
branches:
66
- main
7-
push:
8-
branches:
9-
- main
107
workflow_dispatch:
118

129
jobs:

README.md

+10-13
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ By default, the output(s) from the command are masked from the GitHub Actions lo
2525

2626
* `silent`: (Optional; default: _true_) If set to _false_ the action will not mask or suppress the command or outputs from the logs or console.
2727

28-
> **Note:** the output does not need to be visible in the log to be used as an > input by another task.
28+
> **Note:** the output does not need to be visible in the log to be used as an input by another task.
2929
3030
## Outputs
3131

3232
* `output`: will contain the results of the command in JSON format.
33-
* `raw_output`: if the output of a given query is a single string value, this will return the string without surrounding quotes.
33+
* `raw_output`: if the output of a given query is a single string value, `raw_output` will return the string without surrounding quotes.
3434

3535
> **Note:** filtering the `output` or `raw_output` by piping it through another tool like `jq` may result in the filtered output being visible in the job logs. We recommend using the `query` parameter instead.
3636
@@ -40,7 +40,7 @@ The following example lists all compute instances found in the `testing` compart
4040

4141
To change the name of the compartment, modifying the `query` parameter of the `find-compartment-id` step.
4242

43-
To change which fields are returned, modify the `query` parameter of the `find-instasnces` step.
43+
To change which fields are returned, modify the `query` parameter of the `find-instances` step.
4444

4545
```yaml
4646
jobs:
@@ -55,42 +55,39 @@ jobs:
5555
OCI_CLI_REGION: ${{ secrets.OCI_CLI_REGION }}
5656
steps:
5757
- name: Retrieve the OCID of a named compartment in tenancy
58-
uses: oracle-actions/[email protected]
58+
uses: oracle-actions/[email protected].1
5959
id: find-compartment-id
6060
with:
6161
command: 'iam compartment list --compartment-id-in-subtree=true'
6262
query: "data[?name=='testing'].id"
6363

6464
- name: Retrieve the display name and shape of the instances in my compartment
65-
uses: oracle-actions/[email protected]
65+
uses: oracle-actions/[email protected].1
6666
id: find-instances
6767
with:
6868
command: 'compute instance list --compartment-id ${{ steps.find-compartment-id.outputs.raw_output }}'
6969
query: 'data[*].{name: \"display-name\", shape: shape}'
7070

7171
- name: List the display name and shape of the instances in my compartment
7272
run: |
73-
echo ${{ steps.find-my-compartment-instances.outputs.output }} | jq .
73+
echo ${{ steps.find-instances.outputs.output }} | jq .
7474
```
7575
7676
Consult the [JMESPath documentation][4] for details on how to create more complex queries and result formatting and [`action.yml`](./action.yml) for more detail on how to configure this action..
7777

7878
## Contributing
7979

80-
We welcome contributions from the community. Before submitting a pull
81-
request, please [review our contribution guide](./CONTRIBUTING.md).
80+
We welcome contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md).
8281

8382
## Security
8483

85-
Please consult the [security guide](./SECURITY.md) for our responsible security
86-
vulnerability disclosure process.
84+
Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process.
8785

8886
## License
8987

90-
Copyright (c) 2021, 2022, Oracle and/or its affiliates.
88+
Copyright (c) 2021, 2023, Oracle and/or its affiliates.
9189

92-
Released under the Universal Permissive License v1.0 as shown at
93-
<https://oss.oracle.com/licenses/upl/>.
90+
Released under the Universal Permissive License v1.0 as shown at <https://oss.oracle.com/licenses/upl/>.
9491

9592
[1]: https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/clienvironmentvariables.htm
9693
[2]: https://docs.github.com/en/actions/learn-github-actions/environment-variables

0 commit comments

Comments
 (0)