Skip to content

Commit

Permalink
Misc doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Vadorequest committed Feb 4, 2021
1 parent 4a83aca commit 317048f
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,11 +149,13 @@ The workflow is a bit more complicated:
> Learn how to enable logging, from within the `github-action-await-vercel` action.

## How to enable debug logs

Our GitHub Action is written using the GitHub Actions native [`core.debug` API](https://github.com/actions/toolkit/blob/main/docs/action-debugging.md#step-debug-logs).

Therefore, it allows you to enable logging whenever you need to debug **what's happening within our action**.

**To enable debug mode**, you have to set a [**GitHub Secret**](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets#creating-encrypted-secrets), such as:

- `ACTIONS_STEP_DEBUG` of value `true`

Please see [the official documentation](https://github.com/actions/toolkit/blob/main/docs/action-debugging.md#how-to-access-step-debug-logs) for more information.
Expand All @@ -179,11 +181,13 @@ Then, you'll need to create and add your own Vercel token there (`VERCEL_TOKEN`)
---

# Changelog

[Changelog](./CHANGELOG.md)

---

# Releases versioning

We follow Semantic Versioning. (`major.minor.patch`)

Our versioning process is completely automated, any changes landing on the `main` branch will trigger a new [release](../../releases).
Expand All @@ -196,6 +200,7 @@ Our versioning process is completely automated, any changes landing on the `main
- E.g: Documentation, tests, refactoring, bug fix, etc.

## Releases versions:

- We do not provide major versions that are automatically updated (e.g: `v1`).
- We only provide tags/releases that are not meant to be changed once released (e.g: `v1.1.0`).

Expand All @@ -205,6 +210,7 @@ Our versioning process is completely automated, any changes landing on the `main
---

# License

[MIT](./LICENSE)

---
Expand Down

0 comments on commit 317048f

Please sign in to comment.