Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update deploy command to work inline #1166

Closed
wants to merge 1 commit into from

Conversation

johnathan-sq
Copy link

Summary

I struggled to get the example working from the main README, this should fix that. As it now corresponds to the module initialised in the sample step.

Error being...

Usage: ftl deploy <dirs> ... [flags]
Run "ftl deploy --help" for more information.

ftl: error: <dirs> ...: stat /....../tf-module-alice: no such file or directory

@wesbillman
Copy link
Collaborator

Thanks @johnathan-sq!

This points out that our README is basically just wrong right now. It's also going to be easier for the short-term to test FTL with go vs. kotlin even though we technically support both. We just have some deadlines that are pushing go a bit faster.

@@ -20,7 +20,7 @@ ftl init kotlin . alice

### Deploy and test the module
```sh
ftl deploy ftl-module-alice
ftl deploy alice
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wanna give these instructions a go and see how they work for you? https://github.com/TBD54566975/ftl/blob/main/CONTRIBUTING.md

If they work well, maybe we can update the README.md at the root to point there instead of having 2 different approaches :)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even those are a bit out of date now that I look at it. Here's a quick set of commands to hopefully get you started and we can use them to update the README(s) as needed. I'm also happy to update these if you'd like as well...

Create a new project to work with ftl

mkdir myproject && cd myproject
hermit init .
hermit install go && hermit install ftl
ftl init go . mymodule
ftl dev . --recreate

These assume you have the shell hooks for hermit setup. If not, you'll need to . ./bin/activate-hermit in your project folder

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wanna give these instructions a go and see how they work for you? https://github.com/TBD54566975/ftl/blob/main/CONTRIBUTING.md

Yep, that works for me. 👍

I like the idea of having some sort of instructions in the README to set things up from scratch.

I do think we should reference the development prerequisites for setting up the hermit environment (and maybe splitting this out from the ftl dev ./examples/go)

The way I see this is, you have your development guide which is focused on people developing on ftl. And then you have the README which can be used for people like me (users) to start a project from scratch without searching through the docs.

I think something like this would work well...

## Development guide 

> Please make sure you have Hermit setup for this work. 

mkdir myproject && cd myproject

hermit init .

hermit install go && hermit install ftl

ftl init go . mymodule

Talk about some hot reloading

Talk about deploying it locally (if we even need this when we have hot reloading)

^ Those are just thoughts, let me sit on it a bit and update the PR of what makes sense in my mind.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And then you have the README which can be used for people like me (users) to start a project from scratch without searching through the docs.

That is what the README does currently do (ftl is installed via brew tap rather than hermit) - it's just that it's bitrotted. I'm working on an adjacent PR that will fix this going forward, I'll tag you on it.

(thanks for trying this out BTW, having newcomers try things out is beneficial)

@johnathan-sq
Copy link
Author

Closing this now due to fixing in #1172

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants