Templates for using datalad/release-action

[jwodder]

Closes #48.

[codecov]

Codecov Report

Base: 92.85% // Head: 92.85% // No change to project coverage 👍

Coverage data is based on head (ba6b488) compared to base (1ea1de5).
Patch has no changes to coverable lines.

❗ Current head ba6b488 differs from pull request most recent head 236c0fa. Consider uploading reports for the commit 236c0fa to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #49   +/-   ##
=======================================
  Coverage   92.85%   92.85%           
=======================================
  Files           5        5           
  Lines          42       42           
=======================================
  Hits           39       39           
  Misses          3        3           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[jwodder]

@yarikoptic Ping.

[yarikoptic]

Looks good to me. @mih any suggestions/objections?

[mih]

I am not sure what to add in the documentation re tailoring for a dedicated extension. I would have no idea what to do personally. We could move the files in .github aside and turn them into a "template" or "sketch". Or add documentation on what they try to achieve. Either way is fine with me. Only the combination of active and no docs should be avoided. To clarify, I am mostly talking about the workflows. The changelog.d is dead-weight for people who don't use scriv, but it also does nothing in that case.

[yarikoptic]

Only the combination of active and no docs should be avoided.

agree

The changelog.d is dead-weight for people who don't use scriv, but it also does nothing in that case.

not really -- scriv would be used by action, so it would be "editable metadata for the release action" even if they don't use scriv directly.

@jwodder, please

• initiate CONTRIBUTING.md here which would have a section on releasing which describes annotation of PRs etc, similar to what we have in DataLad https://github.com/datalad/datalad/blob/maint/CONTRIBUTING.md#releasing-with-github-actions-auto-and-pull-requests . While at it, also please fix that description in DataLad itself which still refers to no longer used auto.
• refer to CONTRIBUTING.md within README.md

[jwodder]

@yarikoptic Note that DataLad's CONTRIBUTING.md contains up-to-date information on the master branch but not on the maint branch, as datalad/datalad#7204 was made against master (despite being after the default branch was changed). There are also various other differences between the two branches' versions of the file. What exactly should be done about this, and by whom?

[jwodder]

@yarikoptic

refer to CONTRIBUTING.md within README.md

Refer to it how? What exactly should be said?

[yarikoptic]

@yarikoptic

refer to CONTRIBUTING.md within README.md

Refer to it how? What exactly should be said?

in datalad we have

# Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) if you are interested in internals or
contributing to the project.

which sounds good to paste here.

There are also various other differences between the two branches' versions of the file. What exactly should be done about this, and by whom?

oh ok, nevermind then... @bpoldrack soon will cut new major minor release so it would become up to date... if doesn't happen then we would bring it up again.

[yarikoptic]

ok, I think this PR is ready. Added it to tomorrow's meetup agenda to seek feedback/blessing

[mih]

This is reading an extension for using the release action, but does not impose its use. All good with me. Thx!