Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Project: allow me to write a new project.yaml file without UUIDs

Aperta
  • Qualcosa non va?
#1,398 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
30/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Tranquilla
Stack tecnologico
typescript
Ambito
cli

Direzione di ricerca

Inizia leggendo la issue correlata #1169 e tracciando i percorsi esistenti dei comandi pull, save, export e del possibile eject. Il lavoro è completo quando è possibile condividere una rappresentazione stateless del progetto in un singolo file, senza UUID, dati di endpoint o di dominio, né collocazione in .projects, con lo stato raggruppato sotto chiavi .openfn.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

When I pull a project with new sync, I am left with two different artefacts:

  • A "project.yaml" file (which really needs a better name) which is a direct representation of the project state. It's basically a state.json file, although formatted a bit more cleanly.
  • A "workflows" folder and some config files, which allow me to read and run the workflows of my project locally

We're currently on the verge of saying: the workflows folder is the unit of portability, that's the thing you share with other users.

But a folder is a bit awkward to share. You have to zip it and extract it.

So I'm dithering on the idea of expanded versus unexpected projects.

The projects.yaml file is an unexpanded project - everything in one file. But it's coupled with app state (UUIDs), and I don't want to share that stuff with other users. Plus it's bloaty.

So I need to be able to get a stateless single-file representation of a project. If I export the project from the app, this stateless single file should be what I get. It's exactly the same as the expanded workflows folder, just in one file.

Also important here is that all statey stuff is tucked inside .openfn keys, or something similar. So the state is additive and easy to see.

This is closely related to https://github.com/OpenFn/kit/issues/1169

So I'm repeating myself but this could be an openfn eject command. Or maybe I can pull, save or export with the --stateless command.

Of course the stateless file has no endpoint or domain, and doesn't live in .projects.

Lingua principale
TypeScript
Stelle
21
Fork
22
Merge medio
1g 8h
PR unite (30g)
23

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

  • Include un Dockerfile o un file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di OpenFn/kit

Tutte le issue di OpenFn/kit

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.