From 8f5ec5bfce9c3a02aca7bbdddd8d0903d48bc4a2 Mon Sep 17 00:00:00 2001 From: Antoine du Hamel <duhamelantoine1995@gmail.com> Date: Fri, 14 Jun 2024 12:23:53 +0200 Subject: [PATCH 1/4] Propose vote to unblock `--env-file` PRs Refs: https://github.com/nodejs/TSC/issues/1575#issuecomment-2166976221 --- votes/initiateNewVote/_EDIT_ME.yml | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/votes/initiateNewVote/_EDIT_ME.yml b/votes/initiateNewVote/_EDIT_ME.yml index c9fac556..1536a4ba 100644 --- a/votes/initiateNewVote/_EDIT_ME.yml +++ b/votes/initiateNewVote/_EDIT_ME.yml @@ -3,7 +3,7 @@ # 1. Select a subject for the vote. This can be a question addressed to the TSC # voting members. -subject: REPLACEME +subject: What UX do we want `node` to handle non-existent `.env` files passed to its CLI? # 2. You can leave the header instructions as is, or modify them if you see fit. headerInstructions: | @@ -24,8 +24,12 @@ headerInstructions: | # voters express their preference for each candidates, no matter how many # there are. candidates: - - TODO - - TODO + - Throw when passed to `--env-file` flag, provide no other flag (status quo). + - Warn when passed to `--env-file` flag, provide no other flag. + - Throw when passed to `--env-file` flag, warn when passed to a new `--env-file-if-exists`. + - Throw when passed to `--env-file` flag, do nothing when passed to a new `--env-file-if-exists`. + - Throw when passed to `--env-file` flag, unless new `--env-file-when-missing=warn` is also passed. + - Warn when passed to `--env-file` flag, unless new `--env-file-when-missing=throw` is also passed. # 4. Pass the following to false if it's important to keep the candidates in the # order you define above. Presenting candidates in a fixed order tends to @@ -35,11 +39,15 @@ canShuffleCandidates: true # 5. Insert here a short description of the vote objectives and link to the # issue it was discussed on to give the full context. footerInstructions: | - TBD + Based on the result of this vote, we can unblock either https://github.com/nodejs/node/pull/53177, + https://github.com/nodejs/node/pull/53060, or neither if the status quo prevails. The name of the + proposed flags are non-binding, and are provided only as examples. If a proposal that includes a + new flag, the name of that flag can be bike-shedded per the PR review process. # 6. Optionally, insert a brief introduction for the vote PR, in the markdown format. prBody: | + The vote should stay open for 7 days, or until all TSC voting members have case a ballot. # 7. Optionally, choose an id that will be used for the branch name as well as # the vote folder name. If not supplied, a UUID will be used. -path-friendly-id: null +path-friendly-id: how-to-handle-missing-env-files From 16cdc0e492abe30e1e51ac5af0b1d2e262a22ec9 Mon Sep 17 00:00:00 2001 From: Antoine du Hamel <duhamelantoine1995@gmail.com> Date: Fri, 14 Jun 2024 15:26:53 +0200 Subject: [PATCH 2/4] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Tobias Nießen <tniessen@tnie.de> --- votes/initiateNewVote/_EDIT_ME.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/votes/initiateNewVote/_EDIT_ME.yml b/votes/initiateNewVote/_EDIT_ME.yml index 1536a4ba..dcb48a58 100644 --- a/votes/initiateNewVote/_EDIT_ME.yml +++ b/votes/initiateNewVote/_EDIT_ME.yml @@ -42,11 +42,11 @@ footerInstructions: | Based on the result of this vote, we can unblock either https://github.com/nodejs/node/pull/53177, https://github.com/nodejs/node/pull/53060, or neither if the status quo prevails. The name of the proposed flags are non-binding, and are provided only as examples. If a proposal that includes a - new flag, the name of that flag can be bike-shedded per the PR review process. + new flag is accepted, the name of that flag can be bike-shed per the PR review process. # 6. Optionally, insert a brief introduction for the vote PR, in the markdown format. prBody: | - The vote should stay open for 7 days, or until all TSC voting members have case a ballot. + The vote should stay open for 7 days, or until all TSC voting members have cast a ballot. # 7. Optionally, choose an id that will be used for the branch name as well as # the vote folder name. If not supplied, a UUID will be used. From 0ba834b51ae3c9ff1a199f885c2f437f37ab071e Mon Sep 17 00:00:00 2001 From: Antoine du Hamel <duhamelantoine1995@gmail.com> Date: Fri, 14 Jun 2024 16:10:14 +0200 Subject: [PATCH 3/4] Apply suggestions from code review --- votes/initiateNewVote/_EDIT_ME.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/votes/initiateNewVote/_EDIT_ME.yml b/votes/initiateNewVote/_EDIT_ME.yml index dcb48a58..92250837 100644 --- a/votes/initiateNewVote/_EDIT_ME.yml +++ b/votes/initiateNewVote/_EDIT_ME.yml @@ -3,7 +3,7 @@ # 1. Select a subject for the vote. This can be a question addressed to the TSC # voting members. -subject: What UX do we want `node` to handle non-existent `.env` files passed to its CLI? +subject: How should `node` handle non-existent `.env` files passed via CLI flags? # 2. You can leave the header instructions as is, or modify them if you see fit. headerInstructions: | @@ -25,6 +25,7 @@ headerInstructions: | # there are. candidates: - Throw when passed to `--env-file` flag, provide no other flag (status quo). + - Ignore when passed to `--env-file` flag, provide no other flag. - Warn when passed to `--env-file` flag, provide no other flag. - Throw when passed to `--env-file` flag, warn when passed to a new `--env-file-if-exists`. - Throw when passed to `--env-file` flag, do nothing when passed to a new `--env-file-if-exists`. From d435ed884d0737e47121f5d28cb3097bf6cbb0c5 Mon Sep 17 00:00:00 2001 From: Antoine du Hamel <duhamelantoine1995@gmail.com> Date: Fri, 14 Jun 2024 16:13:35 +0200 Subject: [PATCH 4/4] Apply suggestions from code review --- votes/initiateNewVote/_EDIT_ME.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/votes/initiateNewVote/_EDIT_ME.yml b/votes/initiateNewVote/_EDIT_ME.yml index 92250837..4849d1ab 100644 --- a/votes/initiateNewVote/_EDIT_ME.yml +++ b/votes/initiateNewVote/_EDIT_ME.yml @@ -28,7 +28,8 @@ candidates: - Ignore when passed to `--env-file` flag, provide no other flag. - Warn when passed to `--env-file` flag, provide no other flag. - Throw when passed to `--env-file` flag, warn when passed to a new `--env-file-if-exists`. - - Throw when passed to `--env-file` flag, do nothing when passed to a new `--env-file-if-exists`. + - Throw when passed to `--env-file` flag, ignore when passed to a new `--env-file-if-exists`. + - Ignore when passed to `--env-file` flag, throw when passed to a new `--env-file-must-exist`. - Throw when passed to `--env-file` flag, unless new `--env-file-when-missing=warn` is also passed. - Warn when passed to `--env-file` flag, unless new `--env-file-when-missing=throw` is also passed. @@ -44,6 +45,7 @@ footerInstructions: | https://github.com/nodejs/node/pull/53060, or neither if the status quo prevails. The name of the proposed flags are non-binding, and are provided only as examples. If a proposal that includes a new flag is accepted, the name of that flag can be bike-shed per the PR review process. + "Ignore" means "do not throw and do not warn" in this context. # 6. Optionally, insert a brief introduction for the vote PR, in the markdown format. prBody: |