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.

Sign up for GitHub

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

Jump to bottom

README.md: document the outputs #2024

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

README.md: document the outputs #2024

wants to merge 1 commit into from

Conversation

mtzguido
Copy link

Hi, I noticed the outputs were not documented in the README. They're super useful so I think they should be more prominent.

Could probably use a rewording and I'm not sure if the style is appropriate.

@mtzguido mtzguido requested a review from a team as a code owner December 30, 2024 20:29
lenwood82
lenwood82 reviewed Jan 5, 2025
View reviewed changes
README.md
Copy link

Choose a reason for hiding this comment

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

README.md

Copy link

Choose a reason for hiding this comment

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

README.md

Copy link

Choose a reason for hiding this comment

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

README.md

Comment

Copy link

Choose a reason for hiding this comment

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

Comment

Copy link

Choose a reason for hiding this comment

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

Comment

Setland34
Setland34 reviewed Jan 12, 2025
View reviewed changes
Copy link

@Setland34 Setland34 left a comment

Choose a reason for hiding this comment

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

Approved

Educationchallenged
Educationchallenged suggested changes Jan 30, 2025
View reviewed changes
Copy link

@Educationchallenged Educationchallenged left a comment

Choose a reason for hiding this comment

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

Outputs

The action sets some outputs after a successful run

outputs:
  ref:
    description: 'The branch, tag or SHA that was checked out'

  commit:
    description: 'The commit SHA that was checked out'

@lenwood82
Copy link

Outputs

The action sets some outputs after a successful run

outputs:

  ref:

    description: 'The branch, tag or SHA that was checked out'



  commit:

    description: 'The commit SHA that was checked out'

@lenwood82
Copy link

Comment

lenwood82
lenwood82 reviewed Feb 15, 2025
View reviewed changes
Copy link

@lenwood82 lenwood82 left a comment

Choose a reason for hiding this comment

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

Comment

lenwood82
lenwood82 reviewed Feb 15, 2025
View reviewed changes
Copy link

@lenwood82 lenwood82 left a comment

Choose a reason for hiding this comment

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

Comment

lenwood82
lenwood82 reviewed Feb 15, 2025
View reviewed changes
README.md
commit:
description: 'The commit SHA that was checked out'
```

# Scenarios

- [Fetch only the root files](#Fetch-only-the-root-files)
Copy link

Choose a reason for hiding this comment

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

Comment

Copy link

Choose a reason for hiding this comment

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

Comment

lenwood82
lenwood82 approved these changes Feb 15, 2025
View reviewed changes
Copy link

@lenwood82 lenwood82 left a comment

Choose a reason for hiding this comment

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

Comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Setland34 Setland34 Setland34 left review comments

@Educationchallenged Educationchallenged Educationchallenged requested changes

@lenwood82 lenwood82 lenwood82 approved these changes

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@mtzguido @lenwood82 @Setland34 @Educationchallenged