Skip to content

Allow ALKiln to give notifications to ALKiP to show to authors in the Playground pre-run #1014

Description

@plocket

We sometimes need authors to update ALKiP (ALKilnInThePlayground) at the same time as they update their ALKiln version in order to get the latest features [or possibly, in future, avoid breaking something]. We need to be able to send messages to the authors when they arrive or are installing a new version of ALKiln, etc. [or new information about their current ALKiP version that would help them].

I'm not sure how we will determine what circumstances should trigger various messages [i.e. what variables do we need from ALKiP]. Please discuss.

[
The very first message will be a test and isn't going to show up for authors because it would only show up if an author had updated ALKiP to a version that would show the message, at which point the author doesn't need a message, so it won't show up.

More functionality details: ALKiP will run a new AlKiln command and send relevant details about the environment and the author's actions. This time around, this would have been triggered if the author was about to update ALKiln to a version => 5.15.x while their ALKiP was at >= 1.3.x. We would have needed:

  • The version of ALKiln authors are asking for
  • The version of ALKiln authors are using

Will we need more information in the future?

  • The version of ALKiP they have in the Playground
  • docassemble-os version?
  • Version of AssemblyLine if it's there
  • Potentially all ALKiln-specific env vars, but I can't see why at the moment
  • The paths of files we know we've put on the system...? (runtime_config.json) That might be useful if we ever want to tell authors to get rid of theoretical old files or to tell them they can update to a version of ALKiP that would clean up old files.

]

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request⤵ ALKilnInThePlaygroundIssues for ALKilnInThePlayground. Consolidate here.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions