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: Expand argument table #143

Merged
merged 5 commits into from Jul 7, 2022
Merged

README: Expand argument table #143

merged 5 commits into from Jul 7, 2022

Conversation

tooomm
Copy link
Contributor

@tooomm tooomm commented Jul 7, 2022

I tried to make the docs of this great GitHub Action a bit more friendly for new people.

  • Add Examples column to the table
  • Include args into the table, instead having it in text above
  • Mention where to find default values

@mre
Copy link
Member

mre commented Jul 7, 2022

Good stuff. Thanks a lot!

@mre mre merged commit a520e85 into lycheeverse:master Jul 7, 2022
1 check passed
@tooomm tooomm deleted the patch-1 branch Jul 7, 2022
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