add url to the release in the supplementary material

rseng / zenodo-release

Automated releases to zenodo without granting admin access to webhooks

MIT License

10 stars 4 forks source link

add url to the release in the supplementary material #14

Closed eeholmes closed 8 months ago

eeholmes commented 9 months ago

This addresses issue #13

eeholmes commented 9 months ago

With this pull request the link to supplementary material now points to the current release. Example from my testing.

vsoch commented 8 months ago

This is a great idea! But let's make this still a variable that the user provides. The reason is because they might use the action on a non-release event, or want a different URL used.

vsoch commented 8 months ago

And it should still be optional, meaning the default for html url is set to None and then in the action python script we check if it is defined, and only set it if that's the case. Otherwise folks using the action now will get different behavior.

eeholmes commented 8 months ago

Got it. Where would they define the html_url? Updating the workflow every time a release is made seems non ideal. Perhaps defining an option like

html_url: release_url

And if html_url == "release_url" then that url is used?

But default is None so behavior doesn't change?

vsoch commented 8 months ago

The html url would be another variable for the action
Then in the example (that does a release) you can show that specific metadata from GitHub for them to use.
The action.yml would check if it's defined before adding to the script as a flag
The python variable in the script would check if it's defined before adding to the metadata

eeholmes commented 8 months ago

Closing this pull request since I merged in your changes.