Skip to content

Commit

Permalink
Remove .envrc and show an example in .envrc.sample
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
chmouel authored and tekton-robot committed Nov 28, 2023
1 parent 52bb407 commit 36cd0a1
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 22 deletions.
4 changes: 0 additions & 4 deletions .env.sample

This file was deleted.

18 changes: 0 additions & 18 deletions .envrc

This file was deleted.

7 changes: 7 additions & 0 deletions .envrc.sample
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# shellcheck shell=bash
# This is an example of a .envrc file for use with direnv
#
# See https://direnv.net/#getting-started for more information on how to get
# started with direnv
export GOMAXPROCS=6
export KO_DOCKER_REPO=gcr.io/tektoncd/pipeline

0 comments on commit 36cd0a1

Please sign in to comment.