Feature Request: Defaults in serverless.yaml

[danhumphrey]

When creating a new service, I would like to see the defaults in the serverless.yaml file. I think this avoids ambiguity. The defaults can be edited or removed, but I think the visibility helps with understanding.

If I'm not following protocol in raising this, please correct me..

service: first-service
provider: aws
functions:
    hello:
        handler: handler.hello
defaults:
  stage: "dev"
  region: "us-east-1"
  memory: 1024
  timeout: 6

[pmuens]

Good point.
We're planning to add commented out versions of this in the generated serverless.yaml file (see #1374).

/cc @eahefnawy

[eahefnawy]

@danhumphrey hmmm we used to do that, but we thought it's best if we follow "convention over configuration". Just keeping the config file as minimal as possible and include only essential data and keep the rest as overwrite-able defaults. but just like @pmuens mentioned, we may put in commented config just for the sake of demonstration.

[danhumphrey]

@eahefnawy @pmuens convention over configuration is good assuming that the default config works for the majority of users. Is it an accurate assumption that the majority of users will want to use the same region? or am I misunderstanding this?

Commented config sounds good, but #1374 is closed. Is this still under consideration.

[pmuens]

@danhumphrey It's closed but we're about to implement this in v1 (in a future release).

[pmuens]

A commented out section in the serverless.yml file was added which outlines what one can configure.

The defaults section will be deprecated soon as the new variable system (see #1834) will make configuring things easer.