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 url to the release in the supplementary material #14

Closed
wants to merge 9 commits into from

Conversation

eeholmes
Copy link
Contributor

@eeholmes eeholmes commented Mar 1, 2024

This addresses issue #13

eeholmes added 7 commits March 1, 2024 12:31
Pass in the url to the script so that the link to the supplementary info will go to the current release
So that supplemental link goes to the current release
added html_url to cli.upload_archive() and wasn't supposed to be there
@eeholmes
Copy link
Contributor Author

eeholmes commented Mar 1, 2024

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

image

@vsoch
Copy link
Contributor

vsoch commented Mar 1, 2024

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
Copy link
Contributor

vsoch commented Mar 1, 2024

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
Copy link
Contributor Author

eeholmes commented Mar 1, 2024

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
Copy link
Contributor

vsoch commented Mar 1, 2024

  • 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

Update html url to be an optional parameter
@eeholmes
Copy link
Contributor Author

Closing this pull request since I merged in your changes.

@eeholmes eeholmes closed this Mar 13, 2024
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.

2 participants