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

Quietening the mybinder badge github action #212

Open
manics opened this issue Sep 4, 2020 · 14 comments
Open

Quietening the mybinder badge github action #212

manics opened this issue Sep 4, 2020 · 14 comments

Comments

@manics
Copy link
Member

manics commented Sep 4, 2020

Proposed change

This is a follow-up from manics/jupyter-offlinenotebook#54 (comment)

I think bots that update their comment is the way to go instead of posting a new comment each time.

I've been using the mybinder badge github action from #203 (and #206 #208) on some of my repos.. As @betatim pointed out above the action is a bit too chatty as it comments on every push to the PR 😄

I've written a typescript action that comments once and updates it: https://github.com/manics/action-binderbadge

Alternative options

Do nothing

Who would use this feature?

People who want a badge on PRs without repeated notifications of new comments.

(Optional): Suggest a solution

https://github.com/manics/action-binderbadge
Maybe people could try it out, then later decide whether to recommend it instead of the current action?

@hamelsmu

@welcome
Copy link

welcome bot commented Sep 4, 2020

Thank you for opening your first issue in this project! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out Jupyter's Code of Conduct. Also, please try to follow the issue template as it helps other other community members to contribute more effectively.
welcome
You can meet the other Jovyans by joining our Discourse forum. There is also an intro thread there where you can stop by and say Hi! 👋

Welcome to the Jupyter community! 🎉

@manics
Copy link
Member Author

manics commented Sep 4, 2020

E.g. manics/action-binderbadge#9 (comment)
image

@hamelsmu
Copy link

hamelsmu commented Sep 4, 2020

Wow this is so cool @manics !!!

@hamelsmu
Copy link

hamelsmu commented Sep 4, 2020

@choldgraf @betatim check it out ☝️ I think this is a big improvement!

@choldgraf
Copy link
Member

oh nice! I feel like if this is an improvement to our current action, the best path forward would be to upstream these improvements to it. What do you think?

@hamelsmu
Copy link

hamelsmu commented Sep 4, 2020 via email

@hamelsmu
Copy link

hamelsmu commented Sep 4, 2020

More clarity - I think what @manics made is a new Action, whereas all we have for binder badges are example GitHub workflow examples? Perhaps, it could be worthwhile after testing etc to adopt this Action, too into JupyterHub?

@manics
Copy link
Member Author

manics commented Sep 4, 2020

Exactly! The current action is a GitHub script that uses actions/github-script@v1, whereas this is a standalone action, so upstreaming effectively means transferring the action repo to the jupyterhub org. That's why I thought people should try it out first before we commit to supporting it.

@choldgraf
Copy link
Member

ahh I see - OK cool I think I had thought we already had an action for some reason , but was mistaken 👍

@manics
Copy link
Member Author

manics commented Sep 5, 2020

@choldgraf Maybe you're thinking of https://github.com/jupyterhub/repo2docker-action ?

@choldgraf
Copy link
Member

mostly I am just sleep deprived because I've got a 16 day old infant on my hands :-)

@hamelsmu
Copy link

hamelsmu commented Sep 5, 2020

No worries. Seems like you are the most productive new father I know! Also congrats!🎈

@betatim
Copy link
Member

betatim commented Sep 6, 2020

I like it when bots update their comments instead of spamming a PR with comments :)

But I know nothing about GH Actions vs workflows so I defer to someone else.

On the "trying it out" front: can we enable this for the https://github.com/binder-examples/ repositories?

@manics
Copy link
Member Author

manics commented Sep 7, 2020

I've opened PRs for the 4 pinned binder-example repositories.

I've also got a script that can be used to add it (or any other config file) to other repos...
https://github.com/manics/github-batch-updater
for r in conda r-conda r requirements; do GITHUB_TOKEN=<secret> ./main.js addfile binder-badge.yml --base binder-examples/$r --dest .github/workflows/binder-badge.yml --branch add-binder-badge --title 'Automatically add mybinder badge on PRs' --body $'Add workflow to create a binder badge comment on PRs\n\nSee https://github.com/jupyterhub/binder/issues/212#issuecomment-687706341' --force; done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants