Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README.md: document the outputs #2024

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

README.md

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

README.md

Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,18 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
```
<!-- end usage -->
# Outputs
The action sets some outputs after a successful run
```yaml
outputs:
ref:
description: 'The branch, tag or SHA that was checked out'

commit:
description: 'The commit SHA that was checked out'
```
# Scenarios
- [Fetch only the root files](#Fetch-only-the-root-files)
Expand Down