core: Update "core.error" documentation (#905)

Change the `core.error` documentation to say that it won't automatically
fail the action. This matches the existing example in the "logging" section
This commit is contained in:
Rob Cowsill 2023-01-11 19:12:52 +00:00 committed by GitHub
parent 34577b269e
commit 71a6fceb8c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -121,7 +121,7 @@ const result = await core.group('Do something async', async () => {
This library has 3 methods that will produce [annotations](https://docs.github.com/en/rest/reference/checks#create-a-check-run). This library has 3 methods that will produce [annotations](https://docs.github.com/en/rest/reference/checks#create-a-check-run).
```js ```js
core.error('This is a bad error. This will also fail the build.') core.error('This is a bad error, action may still succeed though.')
core.warning('Something went wrong, but it\'s not bad enough to fail the build.') core.warning('Something went wrong, but it\'s not bad enough to fail the build.')