toolshed/organising
7
1
Fork 0
Code Issues 102 Pull Requests Releases Activity

Specify a different git location for a recipe #533

New Issue
Closed
opened 2023-11-10 09:39:19 +00:00 by p4u1 · 7 comments
p4u1 commented 2023-11-10 09:39:19 +00:00
Owner
Copy Link
Copy Source

Use Case:

I find a bug in a recipe or create a new feature and make those changes in the ~/.abra/recipes/<myrecipe>, so I can directly deploy the fix or the new feature. Next I push the changes to a fork and upstream the changes. While waiting for the changes to land upstream all other people managing the same server must manually change the recipe to my fork and checkout the correct branch. This is quite error prone, since I need to inform them manually and they need to do the correct git operations manually.

Feature Request:
It would be nice to optionally specify a git repository for a recipe. I can think of two places where this could be specified:

  1. In the apps .env file using e.g. a GIT_REPO env variable
  2. By overriding the catalogue somehow (#139)

With either method it would be nice to have a command for it (but not required). But it must be easy to add this information to a git repository managing the server.

**Use Case:** I find a bug in a recipe or create a new feature and make those changes in the `~/.abra/recipes/<myrecipe>`, so I can directly deploy the fix or the new feature. Next I push the changes to a fork and upstream the changes. While waiting for the changes to land upstream all other people managing the same server must manually change the recipe to my fork and checkout the correct branch. This is quite error prone, since I need to inform them manually and they need to do the correct git operations manually. **Feature Request:** It would be nice to optionally specify a git repository for a recipe. I can think of two places where this could be specified: 1. In the apps `.env` file using e.g. a `GIT_REPO` env variable 2. By overriding the catalogue somehow (#139) With either method it would be nice to have a command for it (but not required). But it must be easy to add this information to a git repository managing the server.
p4u1 added the enhancement label 2023-11-10 09:39:19 +00:00
p4u1 changed title from Specify a differnt git location for a recipe to Specify a different git location for a recipe 2023-11-10 09:59:11 +00:00
decentral1se commented 2023-11-28 09:21:30 +00:00
Owner
Copy Link
Copy Source

Thanks for raising, important one!

In the apps .env file using e.g. a GIT_REPO env variable

I wonder could this feed into: https://docs.coopcloud.tech/federation/resolutions/in-progress/013/ somehow 🤔 Generally, the simplest solution to replace your now laborious work-around is probably the one we'd want to go with. So, please feel free to sketch out something that you think will practically work for yourselves.

So, abra would honour a GIT_REPO=... remote URL in a .env file and then use that to clone the recipe if not present? Otherwise, it respects the remote and pulls from there, so that would be fine. It would try to check out tags from the catalogue tho and if those are not present in your forked recipe, that might be an isssue. However, I believe local tags are also respected and a "fetch all tags" is arranged by abra. Maybe if GIT_REPO=... is set, we ignore the (centralised) catalogue for now? Unsure, this would need some testing.

Probably you want to have a way to specify a branch in that env var? There might be something standard we can parse.

Thanks for raising, important one! > In the apps .env file using e.g. a GIT_REPO env variable I wonder could this feed into: https://docs.coopcloud.tech/federation/resolutions/in-progress/013/ somehow 🤔 Generally, the simplest solution to replace your now laborious work-around is probably the one we'd want to go with. So, please feel free to sketch out something that you think will practically work for yourselves. So, `abra` would honour a `GIT_REPO=...` remote URL in a `.env` file and then use that to clone the recipe if not present? Otherwise, it respects the remote and pulls from there, so that would be fine. It would try to check out tags from the catalogue tho and if those are not present in your forked recipe, that might be an isssue. However, I believe local tags are also respected and a "fetch all tags" is arranged by `abra`. Maybe if `GIT_REPO=...` is set, we ignore the (centralised) catalogue for now? Unsure, this would need some testing. Probably you want to have a way to specify a branch in that env var? There might be something standard we can parse.
p4u1 commented 2023-11-29 13:43:26 +00:00
Author
Owner
Copy Link
Copy Source

I have an idea, to combine the two proposals:

We define a new Variable RECIPE which can consist of two parts:
a recipe definition and a version separated by a colon. Some examples:

RECIPE=wordpress # wordpress recipe from catalog
RECIPE=wordpress:1.2 # specific version

RECIPE=https://git.coopcloud.tech/p4u1/wordpress # recipe from git repo
RECIPE=https://git.coopcloud.tech/p4u1/wordpress:my-branch # using a specific branch

Recipe Definition
A recipe definition can be one of the following

  • a recipe name from the catalogue (with #139 the default catalogue can be overridden)
  • a git repository url starting with https://
  • (a local directory)

Version
A version can be any git ref. This includes tags, branches and commits.
When RECIPE contains a version, it gets updated when using the abra app upgrade and related commands.

I can further refine this proposal, If you think this is right direction.

I have an idea, to combine the two proposals: We define a new Variable `RECIPE` which can consist of two parts: a `recipe definition` and a `version` separated by a colon. Some examples: ``` RECIPE=wordpress # wordpress recipe from catalog RECIPE=wordpress:1.2 # specific version RECIPE=https://git.coopcloud.tech/p4u1/wordpress # recipe from git repo RECIPE=https://git.coopcloud.tech/p4u1/wordpress:my-branch # using a specific branch ``` **Recipe Definition** A recipe definition can be one of the following - a recipe name from the catalogue (with #139 the default catalogue can be overridden) - a git repository url starting with `https://` - (a local directory) **Version** A version can be any git ref. This includes tags, branches and commits. When `RECIPE` contains a version, it gets updated when using the `abra app upgrade` and related commands. I can further refine this proposal, If you think this is right direction.
👍 3 🚀 1
decentral1se commented 2023-11-29 17:36:53 +00:00
Owner
Copy Link
Copy Source

Oh yeh, that looks pretty damn solid to me @p4u1 🎉

It seems also like a smaller stepping stone towards OPERATOR_SYNC_VERSION like functionality in https://docs.coopcloud.tech/federation/resolutions/in-progress/013/#details-budget-007 without the syncronisation? Maybe more people can agree to this first step.

@moritz any thoughts on this one?

Oh yeh, that looks pretty damn solid to me @p4u1 🎉 It seems also like a smaller stepping stone towards `OPERATOR_SYNC_VERSION` like functionality in https://docs.coopcloud.tech/federation/resolutions/in-progress/013/#details-budget-007 without the syncronisation? Maybe more people can agree to this first step. @moritz any thoughts on this one?
moritz commented 2023-11-30 15:51:10 +00:00
Member
Copy Link
Copy Source

Love this idea.
I would like to add the git commit as version for a specific chaos deployment #517:

RECIPE=wordpress:2.5.1+6.3.0
RECIPE=https://git.coopcloud.tech/p4u1/wordpress:2.5.1+6.3.0
RECIPE=wordpress:1c70a89ed42de
RECIPE=https://git.coopcloud.tech/p4u1/wordpress:1c70a89ed42de
Love this idea. I would like to add the git commit as version for a specific chaos deployment #517: ``` RECIPE=wordpress:2.5.1+6.3.0 RECIPE=https://git.coopcloud.tech/p4u1/wordpress:2.5.1+6.3.0 RECIPE=wordpress:1c70a89ed42de RECIPE=https://git.coopcloud.tech/p4u1/wordpress:1c70a89ed42de ```
👍 3
decentral1se added the abra label 2024-03-27 06:22:48 +00:00
decentral1se commented 2024-06-24 22:05:18 +00:00
Owner
Copy Link
Copy Source

The wheels are turning! coop-cloud/abra#420

The wheels are turning! https://git.coopcloud.tech/coop-cloud/abra/pulls/420
decentral1se added this to the (deleted) project 2024-06-24 22:05:36 +00:00
decentral1se commented 2024-07-10 11:43:47 +00:00
Owner
Copy Link
Copy Source

Too hasty closing this, we need some integration tests and docs still 🤓

Too hasty closing this, we need some integration tests and docs still 🤓
decentral1se commented 2024-07-10 14:15:08 +00:00
Owner
Copy Link
Copy Source

b8e1a3b75f
7672eea434

https://git.coopcloud.tech/coop-cloud/abra/commit/b8e1a3b75fed1cfdbf1642b4a88855b0a7ccce85 https://git.coopcloud.tech/coop-cloud/docs.coopcloud.tech/commit/7672eea434ea91713076f7e7b94fb11f52b61c4f
❤️ 1
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
abra
Everything to do with abra
 awaiting-feedback
Ping/pong on comms
 backups
bug
Something is not working
 build
Go build related issues
 ci/cd
Getting the robots into the mix
 community organising
Opening this thing up
 contributing
Contributors stuff
 coopcloud.tech
Our main website
 design
Design thinking required
 documentation
Let's write things together
 duplicate
This issue or pull request already exists
 enhancement
New feature
 fedi
Democratic decision making
 fedi-infra
finance
Money things
 funding
Anything related to grant funding
 good first issue
Easy start with development
 help wanted
Need some help
 installer
Installation related issues
 legal
performance
Performance related
 proposal
Large change which requires feedback & decisin making
 question
More information is needed
 security
Securing our shit
 test
Unit or integration test suite
 wontfix
This won't be fixed
No labels abra enhancement
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
3wordchant aadil (Aadil Ayub) abra-bot (Abra Bot) ammaratef45 amras (Sarma) Apfelwurm BornDeleuze Brooke carla cas (Cassowary) coopcloud cyrnel decentral1se (d1) dede devydave fauno (fauno) iexos jade (Jade Ambrose) jjsfunhouse jmakdah2 (Jackie Makdah) joe-irving (Joe Irving) kawaiipunk (KawaiiPunk) knoflook kolaente lambdabundesverband linnealovespie (April) moosemower moritz notplants oxaliq (sorrel) p4u1 pharaohgraphy (Andrew 🐦‍🔥❤️‍🔥✴️) renovate-bot (Comrade Renovate Bot) ripclap simon sixsmith (Sixsmith) stevensting trav (Trav Fryer) val (val (he/him)) yksflip
No Assignees
3 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: toolshed/organising#533