Tips on connecting AD to a Github repo

Although we are finding the integration between AD and Github repos to be really very good now with support for private repositories and organisational accounts, there are still some fiddly aspects to connecting, particularly if like me, you have access to a large number of Github repos.

This short video explains how to setup a Github backed repo in AD work and how to work around these issues.

openEHR - Adding a GitHub-backed repo to Archetype Designer

10 Likes

This is super helpful, thanks Ian! :star_struck: I’ve distributed it to the entire Norwegian modelling team

1 Like

Hi Ian,

thanks for this video, it was a useful tip.
However, we are having some troubles with setting up AD with Read access to a GitHub repo, even when following this guide.

Fetching changes reliably works for private and public, personal and company repos. However, saving changes is tricky, and in most cases committing a change made in AD results in a 500 error, the same as this one.
Committing changes from AD seems to work reproducibly on the main branch of a fresh repo (public or private), but breaks quickly, for example as soon as other sources contribute, or when connecting to a branch other than “main”, although we could not find a definite point yet at which the Commits reproducibly stop working.

Since this seems to work well for you and many others, maybe there is an easy thing we are doing wrong. We are working on the normal web version, currently on version v1.24.14-A3, and would want to synch it with private repos within our company GitHub Account (although the errors also appear on public personal repos…).

I can provide more info if needed, but I kind of suspect there are some fundamental things we are doing wrong, but cannot figure out :sweat_smile:

Hi Hendrik,

I don’t have any particular ideas, other than that to say that we are using GH-backed repos, including private/public/ branches etc routinely now and very rarely have any issues, though there was one a few weeks back related to a clone of the intertnational CKM repo which seems to have been fixed.

What we are not doing is to merge branches or to do any international simultaneous working on a repo, also all of our Git repo collaborators have at least write access i.e no read-only.

Have you tried inspecting the errors in the Browser debug feature. This can sometimes be helpful, though most of the key AD calls are at a service layer not in the browser client.

Happy to jump on a brief call and have a look, if that helps.

Ian

This may seem obvious so apologies if so, and I am no expert in GitHub, but I set up a public repo in GitHub and linked it to AD a few months ago, then shared the repository details with a colleague for using his AD client to link to it. All seemed good and he could read stuff no problem, but then when he came to commit he got a 500 error.

I had to specifically set him up in Github as a collaborator:

And that fixed the problem. So even if a public GitHub repo and access via AD are set up, you still need to sort their permissions over in GitHub also.

Paul

2 Likes