feat: added full list of environement credentials

[vickywane]

This pull request modifies the README.md file to contain a full list of environment variables used within this API.

[commit-lint[bot]]

Features

• added full list of environement credentials (f074e41)

Contributors

vickywane

Commit-Lint commands

You can trigger Commit-Lint actions by commenting on this PR: - `@Commit-Lint merge patch` will merge dependabot PR on "patch" versions (X.X.Y - Y change) - `@Commit-Lint merge minor` will merge dependabot PR on "minor" versions (X.Y.Y - Y change) - `@Commit-Lint merge major` will merge dependabot PR on "major" versions (Y.Y.Y - Y change) - `@Commit-Lint merge disable` will desactivate merge dependabot PR - `@Commit-Lint review` will approve dependabot PR - `@Commit-Lint stop review` will stop approve dependabot PR

[netlify[bot]]

:heavy_check_mark: Deploy Preview for hopeful-bell-0b6f9f ready!

:hammer: Explore the source changes: f074e41a89ab102237b01f08c0c380bf9d27a5a9

:mag: Inspect the deploy log: https://app.netlify.com/sites/hopeful-bell-0b6f9f/deploys/60c7d8f7ad520f000873d596

:sunglasses: Browse the preview: https://deploy-preview-19--hopeful-bell-0b6f9f.netlify.app

[vickywane]

@ivelin The CI keeps breaking due to the Netlify deployment bug.

I am still in touch with the Netlify support engineers and it's something they are actively working on. Till they provide a fix we have to ignore it.

[ivelin]

@vickywane

Please clarify in the document which ones are required by github during CI build time and which ones are required by Netlify during function runtime?

When the code is build and run locally, all variables are in the same local environment. But that is not the case when the build is done via CI and deployment is separately done on Netlify where the functions run.

[vickywane]

@ivelin I went through the readme explanation.

I can see the explanations on environment credentials are quite confusing so I rephrased them and clarified the needed environment variables.

The environment variables you need for deployment and also running locally are in the Running Locally section. For the Github Actions, the env vars are list in the CI / CD Pipeline section of the README.

[ivelin]

I would suggest instead adding a separate section after CI that focuses on the cloud deployment environments such as Netlify.

You may even want to clarify in each section that developers should use their test keys for local and preview deployments. And respectively deployment keys WITH A LOT OF CAUTION when deploying live.

On Mon, Jun 14, 2021 at 3:54 PM Nwani Victory @.***> wrote:

@.**** commented on this pull request.

In README.md https://github.com/ambianic/ambianic-subscriptions/pull/19#discussion_r651270113 :

-- STRIPE_KEY

• GITHUB_TOKEN

Basically, the credentials listed in the Running Locally section are used when deployed to Netlify. The only difference is the variables are stored in a .env file locally and are stored in Netlify when deployed.

Would it be sufficient to rename that section to Executing Serverless Functions and also include a text indicating that the variables are also used within Netlify?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/ambianic/ambianic-subscriptions/pull/19#discussion_r651270113, or unsubscribe https://github.com/notifications/unsubscribe-auth/AARBUFJIYHGFOWT4JBVHYODTSZT7LANCNFSM46RVPDTA .

[ivelin]

@vickywane docs changes should be prefixed in the commit and PR subject with "docs: ..." not "feat: ...".

[vickywane]

Alright.

I would note these against any new next PR. :)