Installing apps from github, the documentation is not complete?

Pipeline Integrations
1

I’m wondering what I’m missing:

> cd /your/development/sandbox
> ./tank install_app shot_step tk-maya user@remotehost:/path_to/tk-multi-mynewapp.git

What is meant by user@remotehost?
I cannot get a app on github to install with the above command, no matter what I try to change, I keep getting:

ERROR:
sgtk:descriptor:dev?path=user@remotehost:github.com/RicardoMusch/tk-multi-setsettings
does not point at a valid bundle on disk!
2 Likes
2

Right, I got it to work by instead of:

user@remotehost:git_url

Using:

https://git_url

and leaving the user@remotehost out

BUT NOW:
Does tank not support the new config system?

ERROR: The configuration for engine 'tk-nuke' located in the environment file
'G:\Projects\pipeline\_configs\shotgun\lola-shotgun-episodic- 
config\config\env\shot_step.yml'
has a reference to another file ('@settings.tk-nuke.shot_step'). This type of
configuration arrangement cannot currently be automatically modified - please
edit it by hand!
2 Likes
3

Going on with the questions, where does Tank Updates pull it’s changelog information from?

It does not seem like that gets pulled from the GitHub release info?

2 Likes
4

Hi Ricardo

The install_app command doesn’t work with the new config, as it doesn’t know how it should handle includes and the way the new config is modulized. The approach is instead to add the app manually to the config. The majority of the other commands should still work if it is a centralized config.

You’re correct, it’s not looking at our Github repos for updates. Sometimes you might see a release in the Github repo that can’t be acquired via the update command. The update command instead reaches out to our app store to ask for the latest version. The app store is not a visible app store you can browse but we use it to control when releases are ready to roll out, and sometimes revert the latest release if issues are found.

1 Like
5

@philip.scadding

You’re correct, it’s not looking at our Github repos for updates. Sometimes you might see a 
release in the Github repo that can’t be acquired via the update command. The update 
command instead reaches out to our app store to ask for the latest version. The app store is 
not a visible app store you can browse but we use it to control when releases are ready to roll 
out, and sometimes revert the latest release if issues are found.

I meant, where does the updates command pull it’s “release notes” from?
Like, when it sees an update to my own app on github it lists the version number of the update, but the “Change Notes/Release notes” is empty. I wondered if it could pull that from the github release notes for custom apps?

2 Likes
6

Ah sorry, I miss understood, just to confirm, is it this sort of thing you are referring to:

----------------------------------------------------------------------
Engine tk-desktop2 (Environment site)
/----------------------------------------------------------------------
| Item:        tk-desktop2 v1.2.5
|
| Description: Shotgun Support in Shotgun Desktop v2
|
| Change Log:  Adds telemetry to the websockets implementation.
\----------------------------------------------------------------------
Update to tk-desktop2 v1.2.5? [Yna?]

if so I’m not actually sure how that works at the moment.
A quick look at the code seems to suggest that a git descriptor might be able to pull this but I’ll need to confirm.

2 Likes
8

Yeah thats what I’m after. It’s not hugely important but just wondering if I need to place that info somewhere for it to pick up or if that pulls it somewhere more propietary :slight_smile:

1 Like
10

Hi Ricardo – @philip.scadding and I discussed this with @Will_Cavanagh on the Toolkit engineering team this morning and, looking through the code, we discovered that the only descriptor that actually implements the get_changelog() method in a meaningful way is the app_store descriptor:

So, if you’re using a git or github_release descriptor, you’d need to reimplement the get_changelog() method, adding the logic for it to show what you want. Of course, this would require you to fork tk-core, which isn’t great.

It sounds like a reasonable feature request for us to implement it at least for github_release, getting the headline from the release comment, and the hope is that it wouldn’t be too much work to do that. I’ve shared the request with the product team, so hopefully we can get it going!

3 Likes
12

Awesome Tannaz, its really not that important, was just wondering if I had to do something.
But if you guys want to implement it, go ahead of course :slight_smile:

3 Likes