Skip to content
This repository was archived by the owner on Feb 10, 2021. It is now read-only.

doc(configuration): Add missing documentation for stage#3

Open
ShaunEdiger wants to merge 1 commit intoFinancial-Times:masterfrom
ShaunEdiger:feature/fix-missing-stage-docs
Open

doc(configuration): Add missing documentation for stage#3
ShaunEdiger wants to merge 1 commit intoFinancial-Times:masterfrom
ShaunEdiger:feature/fix-missing-stage-docs

Conversation

@ShaunEdiger
Copy link

Steps to reproduce

  1. Follow instructions in README to configure a project for healthchecks
  2. sls deploy

Expected Result

The plugin will detect the healthchecks specified within the lambda function events.

Actual Result

The plugin does not detect the healthchecks specified within the lambda function events. Healthcheck processing is skipped entirely (HealthCheck: no lambda to check).

What's going on

There is code within the plugin that toggles whether a lambda function will be included for healthcheck processing. It appears to be undocumented.

What this pull request does

The acceptable configuration values have been added to the README. There are also a few typo corrections.

…ck` property for each function; otherwise, the function is skipped, even if an event is configured for a healthcheck

- fix some typos
Copy link

@mgarciadelojo mgarciadelojo left a comment

Choose a reason for hiding this comment

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

This would be really useful to have, since the documentation is not clear enough...

@wheresrhys
Copy link
Contributor

@ShaunEdiger We no longer use this package at FT. If you want the npm project transferred to you let me know: rhys.evans@ft.com

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants