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

Add Checkbox Formatting Option for Markdown Reports #1623

Merged
merged 4 commits into from
Feb 6, 2025

Conversation

Arteiii
Copy link
Contributor

@Arteiii Arteiii commented Feb 6, 2025

fixes #1610

@mre
Copy link
Member

mre commented Feb 6, 2025

@Arteiii, can you rebase on top of master? I just fixed the clippy lint issues (#1625). That should make the build green.

@mre
Copy link
Member

mre commented Feb 6, 2025

Looks good!

The one thing I'd change is how "task" URLs show up in the progress bar:

1/1 ━━━━━━━━━━━━━━━━━━━  - [ ] [200] https://wiki.debian.org/pmount    

It would be nice to use a different format for that. Probably it can always be our standard link format. But that's probably fine for now; just a little improvement idea for the future.

@mre mre merged commit e29a3c5 into lycheeverse:master Feb 6, 2025
6 checks passed
@mre mre mentioned this pull request Feb 6, 2025
@mre
Copy link
Member

mre commented Feb 6, 2025

Thanks for the fix @Arteiii!

Next steps

  1. Release a new lychee version
  2. Bump lychee-action to use new version
  3. (Optional) change the default lychee-action output mode to the new task mode.

The last point will require some docs and some additional checks, because we want to support backwards-compatibility.
We have to check if the user explicitly set the --mode argument. If not, we can use task instead.

Examples

Use the default task mode

- name: Run lychee
  uses: lycheeverse/lychee-action@v2
  with:
    args: "."

Use the plain mode

- name: Run lychee
  uses: lycheeverse/lychee-action@v2
  with:
    args: "--mode plain ."

We already do that a couple times here: https://github.com/lycheeverse/lychee-action/blob/f613c4a64e50d792e0b31ec34bbcbba12263c6a6/entrypoint.sh#L25-L35

@Arteiii, in case you'd like to continue working on that, feel free to create an issue in lychee-action. We can track it over there from now on. 😊

@Arteiii
Copy link
Contributor Author

Arteiii commented Feb 6, 2025

yee I noticed this while testing, but wasn't sure if this was the correct behaviour or not, as the other formatters are displayed in the same way (sort of).

I think I can rework this though, depending on whether you want to use a default formatter always or only when task mode is used?

@mre
Copy link
Member

mre commented Feb 6, 2025

Yeah, perhaps we should have the same format for the progress report, no matter the mode.
We could even think of a fancy custom one or a version which only prints the URL.

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.

Option For formatting Markdown with checkboxes instead of *
2 participants