Releases md

[hansvancalster]

Addresses https://github.com/inbo/protocols/pull/19#issuecomment-640438446 in part

[florisvdh]

Nice additions. See some comments below.

In the admin tasks, I think more tasks may be added at the end:

• make a GitHub release from the general tag
• check success of publication steps at protocols.inbo.be and at Zenodo (records both source and rendered)

[florisvdh]

Some further suggestions and ideas.

[florisvdh]

An idea for the protocolhelper package, because this step, and step 1 (version number update) is prone to errors? I.e. one or more functions to:

• determine and print the next protocols tag
• determine and print the next protocol-specific tag(s), i.e. based on the occurrence of dev version(s) in the working directory of current checked out branch
• (optionally:) bump version number of the involved protocol(s) accordingly, and return message(s) on this

[hansvancalster]

Good ideas. I've made an issue of your comment inbo/protocolhelper#27

[hansvancalster]

Done in 65687c6

[florisvdh]

A further idea for the protocolhelper package, to start updating an existing protocol? A function that creates and checks out a new branch (protocol-specific), branching off from origin/master (even if one has not checked out master) after fetching origin/master. And also it adds ".dev" to the version number. No auto-committing though, but perhaps staging of the latter. It would just need the protocol code as an input.

Something like:

protocol_code <- "string-by-user" # check if it exists

And then this git workflow, wrapped in system() or mimicked by git2r:

git fetch origin master  # 'origin' could also be generalized to take the first line of the output of 'git remote'
git branch protocol_code origin/master # make the branch
git push -u origin protocol_code:protocol_code # push the branch
git checkout protocol_code # to be put at the end because it is not a fail-safe command (it may error because of unclean working directory)

Plus the adding of .dev (without committing, but perhaps already staged (git add X)).

[hansvancalster]

idemdito see inbo/protocolhelper#27

[hansvancalster]

The workflow now mentions the use of checklist::new_branch() (currently only in the renv-setup branch) which deals with most steps (except the final step) listed here. So I think we can just use that, possibly wrapped into a protocolhelper function to include the final step.

[florisvdh]

Sounds like a good idea!

[hansvancalster]

@ThierryO after checking the code of checklist::new_branch I noticed that https-protocol to talk to GitHub is not supported. So I guess only SSH is supported. That asks quite a lot of confusing setup-steps from often rather inexperienced Rusers who want to contribute to the protocolsource repo. Is this design decision fixed or can https be allowed. I can write an issue or a PR if I understand the code.

[hansvancalster]

After reading this, it leaves me doubting a little about the preference for SSH.

[ThierryO]

Several NARA colleagues are working with ssh for the latest two years now. So far, only one intervention needed. Due to somebody with a new computer.

[hansvancalster]

I followed the steps (and even wrote a vignette for checklist with all steps), but when I try checklist::new_branch() (within my local clone of the checklist package I want to make a branch to commit the vignette), it fails with this error:

Error in fetch(repo, "origin", verbose = verbose) : 
  Error in 'git2r_remote_fetch': error authenticating: failed connecting agent 

This happens inside checklist::clean_git(). I have set git remote set-url origin [email protected]:inbo/checklist.git.

I have no clue what I did wrong. On the other hand, I think issues such as these can be avoided by switching git2r functions to the equivalent gert functions which has automatic authentication (and which would also allow both SSH and HTTPS).

[ThierryO]

Switching for git2r to gert is a major change. Something I cannot do on short notice. I'm willing to accept a PR .

[hansvancalster]

I might give it a try, but it will also take some time...

[florisvdh]

I think we forgot to merge this one. Doing that now.