filiph / linkcheck

Fast link checker
https://pub.dartlang.org/packages/linkcheck
MIT License
426 stars 51 forks source link

Draft new release to fix GH Action on Marketplace #95

Closed tooomm closed 2 years ago

tooomm commented 2 years ago

Hi @filiph. I took a look and tried to help with making your tool accessible as predefined action for users to easily include in their workflows. This should probably fix the issues described in https://github.com/filiph/linkcheck/issues/93.

After recent updates from @errnesto tried to fix the action, there was still a release missing which included these changes/fixes. The available version for easy consumption at the GitHub Actions Marketplace is pointing at the last available release still (2.0.20 @ Marketplace), which does not contain those fixes yet. Hence a new, updated release is needed: Untitled

Changes:

If you want to change the wording or not include every PR in the changelog let me know or update my branch.

After merging this in, you would only need to tag a new release at the most recent commit on master and your release workflow should trigger and deploy a new version. The GitHub Actions Marketplace should then pick it up as well and it should finally work. 👍

Feel free to squash my commits on merge.

filiph commented 2 years ago

(Please do let me know if there's anything I need to do in GH Actions web administration.)

tooomm commented 2 years ago

@filiph That's awesome, thanks for taking a look and merging this. I hope it finally resolves things for GH Action users.


(Please do let me know if there's anything I need to do in GH Actions web administration.)

You need to create a new release here on GitHub. It looks like you have a GitHub Actions workflow for releases setup to automate this and deploy the assets to it. In order to trigger it, it should be sufficient to create a new tag with the new version number targeting your master branch/the last commit you just merged. Same as you did for the former releases.

I hope that helps?

filiph commented 2 years ago

Ah, yes. Done that now. Let's see if it works. Thanks again!

tooomm commented 2 years ago

Well, looks like your release workflow is running into an issue and failing at the grind pkg-github-all command with

pkg-compile-native failed: Your SDK doesn't have dart2aot or dart2native. This probably means that you're using a 32-bit SDK, which doesn't support native compilation.

I'm not familiar with dart or grind however.


Maybe Guillaume (@Mogztter) can help here. He added the workflow last year.

filiph commented 2 years ago

Ok thanks, I asked about the error over at cli_pkg: https://github.com/google/dart_cli_pkg/issues/101

ggrossetie commented 2 years ago

I've never encountered this error, I searched for an existing issue on dart_cli_pkg but couldn't find one. I think this is the right call to open an issue at dart_cli_pkg, hopefully they will know how to fix it 🤞

filiph commented 2 years ago

My bad, the project used an old version of cli_pkg. Upgraded that now, let's see what happens.

filiph commented 2 years ago

It's alive! https://github.com/filiph/linkcheck/releases/tag/2.0.23

Can either of you please check that this does indeed work as expected? I'm not using Marketplace myself, so I wouldn't know where to start.

Thank you so much!

tooomm commented 2 years ago

That are great news! Happy to hear the issue was solved that quickly.

It looks like the Marketplace did not pick up the new version yet. But it turns out that is simply not a thing and it requires manual updates for now, even though that is not documented.

Solution from the GitHub Community:

  • Go to the repo’s releases page and click on edit on the release I want to publish to the marketplace.
  • Click on update release. Note that I do not change anything in the release and that the “Publish this Action to the GitHub Marketplace” is already checked and all checks are green.


Actually, you could also remove the Publish this Action to the GitHub Marketplace checkmark for the 2.0.20 release as it is broken. Not sure about 2.0.15+1. And the list of changes for 2.0.22 is missing linebreaks. There is an open issue about that on the dart_cli_pkg repo, but it looks like it's intended and the changelog file would need other formatting.


Note: I also found these hints on releasing for the future! https://github.com/filiph/linkcheck#releasing-a-new-version

filiph commented 2 years ago

Thanks @tooomm for guiding me through this. I just pressed the "update release" button. Let's see if that does the trick.

tooomm commented 2 years ago

I just pressed the "update release" button. Let's see if that does the trick.

That did it... 😄


Can either of you please check that this does indeed work as expected? I'm not using Marketplace myself, so I wouldn't know where to start.

It works now! People can now easily use your tool when adding this to their action workflows:

- name: Check links
  uses: filiph/linkcheck@2.0.23
  with:
    arguments: