Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove .envrc and show an example in .envrc.sample #7429

Merged
merged 1 commit into from
Nov 28, 2023

Conversation

chmouel
Copy link
Member

@chmouel chmouel commented Nov 28, 2023

The .envrc file is used by direnv to load the environment variables and
having this file in the repository can cause problems when the user has
already one in his/her home directory.

Moreover this file automatically loads silently the environment
variables from .env bypassing the explicit "direnv allow" that
usually needed with .envrc which can be a potential security issue.

This is still a useful file and to know about for contributors so we
keep the sample file in .envrc.sample and let user copy it to .envrc if
they want to use it.

/kind misc

Changes

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps
  • Has Tests included if any functionality added or changed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including functionality, content, code)
  • Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings). See some examples of good release notes.
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

@tekton-robot tekton-robot added kind/misc Categorizes issue or PR as a miscellaneuous one. release-note-none Denotes a PR that doesnt merit a release note. labels Nov 28, 2023
@tekton-robot tekton-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Nov 28, 2023
The .envrc file is used by direnv to load the environment variables and
having this file in the repository can cause problems when the user has
already one in his home directory.

Moreover this file automatically loads silently the environment
variables from .env.sample bypassing the explicit "direnv allow" that
usually needed with .envrc which can be a potential security issue.

This is still a useful file and to know about for contributors so we
keep the sample file in .envrc.sample and let user copy it to .envrc if
they want to use it.

Signed-off-by: Chmouel Boudjnah <[email protected]>
@tekton-robot tekton-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 28, 2023
@chmouel chmouel changed the title Rename .envrc as .envrc.sample Remove .envrc and show an example in .envrc.sample Nov 28, 2023
@vdemeester
Copy link
Member

/retest
/approve
/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Nov 28, 2023
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vdemeester

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 28, 2023
@tekton-robot tekton-robot merged commit 36cd0a1 into tektoncd:main Nov 28, 2023
3 checks passed
@chmouel chmouel deleted the remove-direnv branch November 28, 2023 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/misc Categorizes issue or PR as a miscellaneuous one. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesnt merit a release note. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants