feat: support branch values for environment variable contexts #4977

jasonbarry · 2022-08-18T22:47:37Z

Summary

Fixes https://github.com/netlify/pillar-workflow/issues/814

This PR lets users specify branches as contexts for the various env commands. netlify build allows using a --context flag to build a site using env vars specified in the toml file as under [context.<thing>.environment], where <thing> is either a reserved context keyword (like dev, production, or deploy-preview), or any string, which corresponds to a git branch.

We've ported over that functionality to the UI to allow these types of branch overrides to be more specific than contexts when the git branch matches. For example, if you set FOO=bar for the branch-deploy context, and also have a branch-specific value of FOO=bang on the staging branch, the value of bang will take precedence when you visit the staging branch's branch deploy.

This PR brings parity to the CLI so that you can use env, build, and dev commands to get/set environment variable values to have a branch-specific value.

You can use branch-specific values simply by using a non-reserved context keyword like ntl env:get --context staging, or by prepending the branch: prefix, like ntl env:get --context branch:staging, for clarity.

Branch names are normalized using commander's custom option processing.

For us to review and ship your PR efficiently, please perform the following steps:

Open a bug/issue before writing your code 🧑‍💻. This ensures we can discuss the changes and get feedback from everyone that should be involved. If you`re fixing a typo or something that`s on fire 🔥 (e.g. incident related), you can skip this step.
Read the contribution guidelines 📖. This ensures your code follows our style guide and
passes our tests.
Update or add tests (if any source code was changed or added) 🧪
Update or add documentation (if features were changed or added) 📝
Make sure the status checks below are successful ✅

A picture of a cute animal (not mandatory, but encouraged)

github-actions · 2022-08-18T22:48:47Z

📊 Benchmark results

Comparing with 2c337b0

Package size: 222 MB

(no change)

^  222 MB  222 MB  222 MB  222 MB  222 MB  222 MB  222 MB  222 MB  222 MB  222 MB  222 MB  222 MB  222 MB 
│   ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
└───┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴──>
    T-12    T-11    T-10    T-9     T-8     T-7     T-6     T-5     T-4     T-3     T-2     T-1      T

Legend

T-30 (f1d1d91): 222 MB
T-29 (56cfac8): 222 MB
T-28 (3af976e): 222 MB
T-27 (7a2af72): 222 MB
T-26 (6fad2a8): 222 MB
T-25 (1450e1e): 222 MB
T-24 (8b8d8b3): 222 MB
T-23 (dfe0365): 222 MB
T-22 (7d792df): 222 MB
T-21 (ba96774): 222 MB
T-20 (48d581a): 222 MB
T-19 (c0a4cad): 222 MB
T-18 (ac4e0e4): 222 MB
T-17 (3073dbb): 222 MB
T-16 (2f9072b): 222 MB
T-15 (091387f): 222 MB
T-14 (a5bfa11): 222 MB
T-13 (cfeea77): 222 MB
T-12 (5342938): 222 MB
T-11 (e0f1680): 222 MB
T-10 (2d4b68c): 222 MB
T-9 (cef0f45): 222 MB
T-8 (54b12c8): 222 MB
T-7 (2a41796): 222 MB
T-6 (59b8162): 222 MB
T-5 (9385dde): 222 MB
T-4 (45d7100): 222 MB
T-3 (c0b9722): 222 MB
T-2 (2cd5d57): 222 MB
T-1 (2c337b0): 222 MB
T (current commit): 222 MB

codebyuma

Looks good to me! Left one suggestion (in two places)

codebyuma · 2022-08-19T13:42:48Z

docs/commands/env.md

+**Examples**
+
+```bash
+netlify env:list # list dev context and any scope


[sand] suggestion to elaborate a bit, similar to the example you used for get:

Suggested change

netlify env:list # list dev context and any scope

netlify env:list # list variables with values in the dev context and with any scope

Wait, I assume this is auto-generated, I'll leave this comment in the JS file :)

codebyuma · 2022-08-19T13:45:55Z

src/commands/env/env-list.js

    )
    .addOption(
      new Option('-s, --scope <scope>', 'Specify a scope')
        .choices(['builds', 'functions', 'post_processing', 'runtime', 'any'])
        .default('any'),
    )
+    .addExamples([
+      'netlify env:list # list dev context and any scope',


[sand] suggestion to elaborate a bit, similar to the example you used for get:

Suggested change

'netlify env:list # list dev context and any scope',

'netlify env:list # list variables with values in the dev context and with any scope',

melanierichards

All my feedback from issues has been addressed, thanks! LGTM!

melanierichards

Refreshing my approval status after the copy updates, LGTM! 🚀

codebyuma · 2022-08-22T12:21:19Z

src/commands/env/env-list.js

@@ -144,7 +144,7 @@ const createEnvListCommand = (program) =>
        .default('any'),
    )
    .addExamples([
-      'netlify env:list # list dev context and any scope',
+      'netlify env:list # list variables with values in the dev context and with any scope',


* feat: support branch values in env:list * feat: support branch values in env:get * feat: support branch values for contexts in build and dev * feat: support branch values for contexts in env:set * feat: support branch values for contexts in env:unset * test: fix some tests * fix: remove cruft * docs: npm run docs * chore: update logs to print either `context` or `branch` correctly * test: update tests * fix: fix example help text in `env:get --help` * fix: fix netlify/pillar-workflow#818 * fix: fix netlify/pillar-workflow#815 * fix: fix netlify/pillar-workflow#816 and fix netlify/pillar-workflow#817 * docs: addressing uma's feedback * chore: update contributors field Co-authored-by: jasonbarry <jasonbarry@users.noreply.github.com>

jasonbarry added 7 commits August 18, 2022 11:23

feat: support branch values in env:list

d4add27

feat: support branch values in env:get

4bbae24

feat: support branch values for contexts in build and dev

2ef72a4

feat: support branch values for contexts in env:set

733018e

feat: support branch values for contexts in env:unset

3fb7da6

test: fix some tests

af9d65f

fix: remove cruft

2069af4

jasonbarry changed the title ~~Feat/branch values in env commands~~ feat: support branch values for env var contexts Aug 18, 2022

github-actions bot added the type: feature code contributing to the implementation of a feature and/or user facing functionality label Aug 18, 2022

jasonbarry self-assigned this Aug 18, 2022

jasonbarry added 4 commits August 18, 2022 16:37

docs: npm run docs

3f8f6e8

chore: update logs to print either context or branch correctly

3b6b846

test: update tests

94bca27

fix: fix example help text in env:get --help

9d2031b

jasonbarry changed the title ~~feat: support branch values for env var contexts~~ feat: support branch values for environment variable contexts Aug 19, 2022

jasonbarry requested review from melanierichards, JGAntunes, lukasholzer and eduardoboucas August 19, 2022 00:34

jasonbarry marked this pull request as ready for review August 19, 2022 00:34

jasonbarry requested a review from a team as a code owner August 19, 2022 00:34

jasonbarry requested a review from codebyuma August 19, 2022 00:35

jasonbarry added 3 commits August 18, 2022 18:10

fix: fix netlify/pillar-workflow#818

5203f6f

fix: fix netlify/pillar-workflow#815

44be6d5

fix: fix netlify/pillar-workflow#816 and fix netlify/pillar-workflow#817

79adc22

codebyuma reviewed Aug 19, 2022

View reviewed changes

melanierichards previously approved these changes Aug 19, 2022

View reviewed changes

docs: addressing uma's feedback

00ec4b6

jasonbarry dismissed melanierichards’s stale review via 00ec4b6 August 19, 2022 23:12

melanierichards previously approved these changes Aug 19, 2022

View reviewed changes

codebyuma previously approved these changes Aug 22, 2022

View reviewed changes

jasonbarry added the automerge Add to Kodiak auto merge queue label Aug 22, 2022

jasonbarry and others added 2 commits August 22, 2022 12:50

Merge branch 'main' into feat/branch-values-in-env-commands

82b9ab3

chore: update contributors field

e136c43

token-generator-app bot dismissed stale reviews from codebyuma and melanierichards via e136c43 August 22, 2022 19:51

melanierichards approved these changes Aug 22, 2022

View reviewed changes

jasonbarry merged commit f434f57 into main Aug 22, 2022

jasonbarry deleted the feat/branch-values-in-env-commands branch August 22, 2022 20:20

token-generator-app bot mentioned this pull request Aug 22, 2022

chore(main): release 11.5.0 #4993

Merged

MaxMood96 mentioned this pull request Dec 1, 2023

[Snyk] Fix for 1 vulnerabilities MaxMood96/cli-2#156

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support branch values for environment variable contexts #4977

feat: support branch values for environment variable contexts #4977

jasonbarry commented Aug 18, 2022 •

edited

github-actions bot commented Aug 18, 2022 •

edited

codebyuma left a comment

codebyuma Aug 19, 2022

codebyuma Aug 19, 2022

codebyuma Aug 19, 2022

melanierichards left a comment

melanierichards left a comment

codebyuma Aug 22, 2022

	netlify env:list # list dev context and any scope
	netlify env:list # list variables with values in the dev context and with any scope

	'netlify env:list # list dev context and any scope',
	'netlify env:list # list variables with values in the dev context and with any scope',

feat: support branch values for environment variable contexts #4977

feat: support branch values for environment variable contexts #4977

Conversation

jasonbarry commented Aug 18, 2022 • edited

Summary

github-actions bot commented Aug 18, 2022 • edited

📊 Benchmark results

Package size: 222 MB

codebyuma left a comment

Choose a reason for hiding this comment

codebyuma Aug 19, 2022

Choose a reason for hiding this comment

codebyuma Aug 19, 2022

Choose a reason for hiding this comment

codebyuma Aug 19, 2022

Choose a reason for hiding this comment

melanierichards left a comment

Choose a reason for hiding this comment

melanierichards left a comment

Choose a reason for hiding this comment

codebyuma Aug 22, 2022

Choose a reason for hiding this comment

jasonbarry commented Aug 18, 2022 •

edited

github-actions bot commented Aug 18, 2022 •

edited