reference front-end is decoupled from version of configuration module #304

Open
opened 2025-04-08 16:47:01 +02:00 by kiara · 1 comment
Owner

As a Fediversity user,
I want a front-end not tightly coupled with the versioning of configuration modules,
so that I may deploy code without having to worry about front-enders' concerns trumping my version preferences.

implementation notes

the deployment module should be separate from the Django code, so that we may explicitly specify what version to invoke deployment for - potentially even including forks (see #100).
to achieve this, a separated repo for the deployment module should specify how code-bases would (given a version) know how to invoke it:

  • document implementation/usage (files paths mentioned following #274)
    • any environment
      • panel/views.py#deploy
      • launch/tf.nix
      • document handling incoming updates for stored configurations (#159)
    • environment-specific
      • prod
        • launch/tf-env.nix
        • document storing state
      • dev
        • launch/default.nix
        • panel/env.nix
  • generated json-schema of valid options (#195)
    • sample ui-schema that may be used in visualization
  • implement version in the panel data schema to support disparities from migration (#100)
    • similarly allowing it to inspect its recommended version (if no longer coupled by mono-repo) to use both as its default value for new deployments
    • in the migration string (#77) add a fetchTree input identifying a Fediversity configuration module source, including pinned version (rev)

implementation notes

  • as it stands, the reference implementation in panel/ may function as documentation of usage.
**As** a Fediversity user, **I want** a front-end not tightly coupled with the versioning of configuration modules, **so that** I may deploy code without having to worry about front-enders' concerns trumping my version preferences. ## implementation notes the deployment module should be separate from the Django code, so that we may explicitly specify what version to invoke deployment for - potentially even including forks (see #100). to achieve this, a separated repo for the deployment module should specify how code-bases would (given a version) know how to invoke it: - [ ] document implementation/usage (files paths mentioned following #274) - any environment - `panel/views.py#deploy` - `launch/tf.nix` - document handling incoming updates for stored configurations (#159) - environment-specific - prod - `launch/tf-env.nix` - document storing state - dev - `launch/default.nix` - `panel/env.nix` - [ ] generated json-schema of valid options (#195) - sample ui-schema that may be used in visualization - [ ] implement version in the [`panel` data schema](https://git.fediversity.eu/Fediversity/meta/pulls/31/files) to support disparities from migration (#100) - [ ] similarly allowing it to inspect its recommended version (if no longer coupled by mono-repo) to use both as its default value for new deployments - [ ] in the migration string (#77) add a [`fetchTree`](https://noogle.dev/f/builtins/fetchTree) `input` identifying a Fediversity configuration module source, including pinned version (`rev`) ### implementation notes - as it stands, the reference implementation in `panel/` may function as documentation of usage.
kiara added this to the Fediversity project 2025-04-14 11:27:14 +02:00
kiara changed title from allow control over version of module deployed to reference front-end decoupled from template version 2025-06-01 16:52:00 +02:00
kiara changed title from reference front-end decoupled from template version to reference front-end decoupled from version of configuration module 2025-06-02 10:22:55 +02:00
kiara changed title from reference front-end decoupled from version of configuration module to reference front-end is decoupled from version of configuration module 2025-06-02 12:52:04 +02:00
Author
Owner

removed from deps of #100 as technically this isn't mandatory to implement the principle, just in production where versions may not match

removed from deps of #100 as technically this isn't mandatory to implement the principle, just in production where versions may not match
kiara removed this from the Fediversity project 2025-06-10 19:06:46 +02:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Reference: fediversity/fediversity#304
No description provided.