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

SEA-232 "rebar3 grisp configure" #78

Merged
merged 14 commits into from
May 3, 2024

Conversation

GwendalLaurent
Copy link
Member

@GwendalLaurent GwendalLaurent commented Apr 26, 2024

Description

This PR adds the configure task to the current rebar3 plugin.
It works with this pull request on grisp_tools: grisp/grisp_tools#21

The goal of that task is to help a user to create a new GRiSP application using a CLI.
When the task is started, it will ask a series of questions to the user to prepare the GRiSP application based on the answers provided.
More precisely, it will ask:

  • The name of the project
  • The OTP version
  • If the users wants a network configuration

If the user requests a network configuration then the CLI will ask:

  • If the user wants to setup a wifi connection. If yes, then the CLI asks for the ssid and the psk of the wifi
  • If the user wants to setup a GRiSP.io application. If yes, then the CLI asks for the token of the user
  • If the user wants to include epmd. If yes, then the CLI asks for the distributed cookie

Note that for each of these options, the CLI provides a default choice.

When the CLI finishes to ask the questions, the task will generate the files for the project using bbmustache

Setup

To test this PR you will need a local setup. Indeed, since the changes aren't pushed on the main branch the version of the plugin globally installed on your computer won't reflect the changes made for this PR. Thus we will need to use a throw off grisp project and use the _checkouts folder to use the correct versions of this repo as well as the grisp_tools repo. Both of them should be setup to checkout the branch named SEA-232-rebar3-grisp-configure

Once this is setup, you can start using rebar3 grisp configure inside your throw off grisp project

How to use

The section "create new application" of the README have been updated. Please use this as a reference tof figure out how to use the new task of the plugin.

@ziopio
Copy link
Member

ziopio commented May 2, 2024

I would improve a bit the text for each prompt

App name ("robot")> bob
Erlang version ("25")> 
SD card Path ("/path/to/SD-card")> /Volumes/GRISP
Use Network ? (y/N)> y
Use Wifi ? (y/N)> y
Network Name ("My Wifi")> Wifi Furbuffo
Password ("...")> 
Enable GRiSP.io integration ? (y/N)> y
Insert your GRiSP.io token if you need to link your board ("...")> 
Enable Erlang Distribution ? (y/N)> y
Erlang cookie ("grisp")> cookie

README.md Show resolved Hide resolved
@ziopio ziopio self-requested a review May 2, 2024 20:24
@GwendalLaurent GwendalLaurent force-pushed the SEA-232-rebar3-grisp-configure branch from 56a2401 to c6a8db0 Compare May 3, 2024 07:27
@GwendalLaurent GwendalLaurent merged commit 44d31aa into master May 3, 2024
6 checks passed
@GwendalLaurent GwendalLaurent deleted the SEA-232-rebar3-grisp-configure branch May 6, 2024 07:18
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.

2 participants