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

Propagate lychee exit code #145

Merged
merged 2 commits into from Jul 12, 2022
Merged

Propagate lychee exit code #145

merged 2 commits into from Jul 12, 2022

Conversation

mre
Copy link
Member

@mre mre commented Jul 11, 2022

Ever since we moved to a composite action the exit code for lychee didn't work as expected.
The reason is that the the output of a step needs to be propagated to an output of the entire
action by setting an explicit parameter in the outputs section.
See https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#outputs-for-composite-actions

Ever since we moved to a composite action the exit code for lychee didn't work as expected.
The reason is that the the output of a step needs to be propagated to an output of the entire
action by setting an explicit parameter in the `outputs` section.
See https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#outputs-for-composite-actions
- run: ${{ github.action_path }}/entrypoint.sh
- name: Run lychee
run: ${{ github.action_path }}/entrypoint.sh
id: lychee
Copy link
Member Author

@mre mre Jul 11, 2022

Choose a reason for hiding this comment

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

Does this id have to be unique across the entire Github action pipeline? If so, rename to lychee-cli-run to avoid conflicts.

Choose a reason for hiding this comment

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

The composite action docs aren't that helpful at clarifying that. I assume it only needs to be unique within this action.yml scope.

So I doubt that will be a concern. Easy enough to verify after it's merged?

Copy link

@polarathene polarathene left a comment

LGTM 👍

action.yml Outdated Show resolved Hide resolved
Co-authored-by: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
@mre mre merged commit 72460ce into master Jul 12, 2022
2 checks passed
@mre mre deleted the exit-code branch Jul 12, 2022
@mre
Copy link
Member Author

mre commented Jul 12, 2022

Thanks for the review @polarathene.

kodiakhq bot pushed a commit to sosiristseng/template-hugo-book that referenced this issue Jul 28, 2022
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [lycheeverse/lychee-action](https://togithub.com/lycheeverse/lychee-action) | action | patch | `v1.5.0` -> `v1.5.1` |

---

### Release Notes

<details>
<summary>lycheeverse/lychee-action</summary>

### [`v1.5.1`](https://togithub.com/lycheeverse/lychee-action/releases/tag/v1.5.1)

[Compare Source](https://togithub.com/lycheeverse/lychee-action/compare/v1.5.0...v1.5.1)

#### Summary

Bump lychee version to fix some regressions and extend the documentation.

#### What's Changed

-   README: Expand argument table by [@&#8203;tooomm](https://togithub.com/tooomm) in [lycheeverse/lychee-action#143
-   Propagate lychee exit code by [@&#8203;mre](https://togithub.com/mre) in [lycheeverse/lychee-action#145
-   Bump lychee version to 0.10.1 by [@&#8203;mre](https://togithub.com/mre) in [lycheeverse/lychee-action#150

#### New Contributors

-   [@&#8203;tooomm](https://togithub.com/tooomm) made their first contribution in [lycheeverse/lychee-action#143

**Full Changelog**: lycheeverse/lychee-action@v1.5.0...v1.5.1

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

 **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox.

---

This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/sosiristseng/template-hugo-book).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzMi4xMjcuNCIsInVwZGF0ZWRJblZlciI6IjMyLjEyNy40In0=-->
github-actions bot pushed a commit to sosiristseng/template-hugo-book that referenced this issue Jul 28, 2022
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [lycheeverse/lychee-action](https://togithub.com/lycheeverse/lychee-action) | action | patch | `v1.5.0` -> `v1.5.1` |

---

### Release Notes

<details>
<summary>lycheeverse/lychee-action</summary>

### [`v1.5.1`](https://togithub.com/lycheeverse/lychee-action/releases/tag/v1.5.1)

[Compare Source](https://togithub.com/lycheeverse/lychee-action/compare/v1.5.0...v1.5.1)

#### Summary

Bump lychee version to fix some regressions and extend the documentation.

#### What's Changed

-   README: Expand argument table by [@&#8203;tooomm](https://togithub.com/tooomm) in [lycheeverse/lychee-action#143
-   Propagate lychee exit code by [@&#8203;mre](https://togithub.com/mre) in [lycheeverse/lychee-action#145
-   Bump lychee version to 0.10.1 by [@&#8203;mre](https://togithub.com/mre) in [lycheeverse/lychee-action#150

#### New Contributors

-   [@&#8203;tooomm](https://togithub.com/tooomm) made their first contribution in [lycheeverse/lychee-action#143

**Full Changelog**: lycheeverse/lychee-action@v1.5.0...v1.5.1

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

 **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox.

---

This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/sosiristseng/template-hugo-book).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzMi4xMjcuNCIsInVwZGF0ZWRJblZlciI6IjMyLjEyNy40In0=-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants