appsignal-elixir icon indicating copy to clipboard operation
appsignal-elixir copied to clipboard

Proposal: Igniter installer

Open zachdaniel opened this issue 10 months ago • 2 comments

Hey folks! Author if igniter here :)

The AppSignal package seems like a great example of a package that could benefit from an igniter installer. It could condense your getting started down to a single command, which can be interactive, will display diffs to the user, etc.

mix igniter.install appsignal

Normally I wouldn't open an issue like this (shilling my own stuff 😆 ), but I'm also the author of Ash Framework, which has an integration for AppSignal. I'm working on our "installer builder", and would love to be able to add AppSignal to it :)

Demo of the upcoming Ash installer: https://bsky.app/profile/zachdaniel.dev/post/3lflx7kcthc2r

zachdaniel avatar Jan 13 '25 19:01 zachdaniel

Hi @zachdaniel, thank you for reaching out! It's an interesting project. We've been interested in improving our integrations' installation experience.

I'm working on [Ash Framework's] "installer builder", and would love to be able to add AppSignal to it :)

What changes would we need to make in order to make this possible?

unflxw avatar Jan 14 '25 14:01 unflxw

The way to accomplish this would be to define a mix task called appsignal.install. You can then use the tools provided by igniter to modify the project as necessary to do the installation.

Here is an example from Oban: https://github.com/oban-bg/oban/pull/1208 And one for installing Ash: https://github.com/ash-project/ash/blob/v3.4.55/lib/mix/tasks/install/ash.install.ex#L2

You would begin by adding igniter as an optional dependency, and then run mix igniter.gen.task appsignal.install which will set you up with the shell of your task.

zachdaniel avatar Jan 14 '25 15:01 zachdaniel