Consider adding a Register action

abelsiqueira / BestieTemplate.jl

Template for Julia Programming Language packages using the copier engine.

http://abelsiqueira.com/BestieTemplate.jl/

Mozilla Public License 2.0

38 stars 9 forks source link

Consider adding a Register action #371

Open abelsiqueira opened 2 months ago

abelsiqueira commented 2 months ago

Description

Like this option of Pkgtemplates: https://juliaci.github.io/PkgTemplates.jl/stable/user/#PkgTemplates.RegisterAction

Validation and testing

No response

Motivation

No response

Target audience

No response

Can you help?

No response

moble commented 1 month ago

I was just about to create a new issue to suggest this, specifically because this section of 91-developer.md would be significantly simplified by suggesting that users go to https://github.com/{{ PackageOwner }}/{{ PackageName }}/actions/workflows/Register.yml and just click the "Run workflow" button.

https://github.com/abelsiqueira/BestieTemplate.jl/blob/b1114d039578dbd5a132a8955c87352e6371448d/template/docs/src/%7B%25%20if%20AddContributionDocs%20%25%7D91-developer.md%7B%25%20endif%20%25%7D.jinja#L144-L155

abelsiqueira commented 1 month ago

I haven't used the Register workflow before so I don't know how it works. It felt like overkill at the time, but sometimes the normal process is confusing for new users, so I see the benefits.

If you can help, I have some questions. It should be easy to find these answers, but if you know them, it's easier:

Does it produce the same result as triggering the bot?
Do you still need to enable the bot in the market place?
Do you need write permissions to trigger the bot?
Does it automatically update the version in Project.toml, or do you still have to do it?

abelsiqueira commented 1 month ago

PS. Is this the action: https://github.com/julia-actions/RegisterAction?

PPS. I just saw https://github.com/julia-actions/RegisterAction/pull/18, so I guess that is the action.