You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As a user that is setting up version control for an already existing project,
I'd like to be able to export a whole directory that I can immediately use as a git repo
To save time and make clearer the process for "linking an existing project" to git.
Details
This builds on Export projects as .yaml via UI #249, which allows users to export their current project configuration as a .yaml file. That .yaml file can be use to do new deployments but it can't be used to immediately start updating an existing project. (In this sense, it's good for portability but not adding version control to existing projects.)
The ideal repo structure for version controlling an OpenFn project includes at least a project.yaml, a .state.json file, and a configuration.json file without an API token. (The API token will be passed in manually, or via GitHub secrets if this repo is being used with a GitHub action as in Github action to deploy changes to Lightning #250 )
The project.yaml export functionality has been delivered in Export projects as .yaml via UI #249, the .state.json functionality is available via the projects API (and is used by the CLI when deploying) and the configuration.json information can be inferred by the current Lightning deployment and decisions—e.g., what will we call the .state.json file, what will we call the project.yaml file, and what is the api endpoint of the current instance: https://app.openfn.org/api or whatever.)
Implementation notes
Start by reviewing the current export as YAML feature.
User Story
Details
.yaml
via UI #249, which allows users to export their current project configuration as a.yaml
file. That.yaml
file can be use to do new deployments but it can't be used to immediately start updating an existing project. (In this sense, it's good for portability but not adding version control to existing projects.)project.yaml
, a.state.json
file, and aconfiguration.json
file without an API token. (The API token will be passed in manually, or via GitHub secrets if this repo is being used with a GitHub action as in Github action to deploy changes to Lightning #250 ).yaml
via UI #249, the.state.json
functionality is available via the projects API (and is used by the CLI when deploying) and theconfiguration.json
information can be inferred by the current Lightning deployment and decisions—e.g., what will we call the.state.json
file, what will we call theproject.yaml
file, and what is the api endpoint of the current instance:https://app.openfn.org/api
or whatever.)Implementation notes
OPENFN_API_KEY=<<yourkey>> openfn deploy -c configuration.json
The text was updated successfully, but these errors were encountered: