From c40e9c6392b05ba58e6fea50091ce35a1ef020e7 Mon Sep 17 00:00:00 2001 From: John Barton Date: Fri, 24 Sep 2021 21:38:50 +1000 Subject: [PATCH 01/14] Fix CI for power8 arch (#157) --- .github/workflows/ci.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 6f91de3..e96faf7 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -41,6 +41,7 @@ jobs: env: | # YAML pipe GOARCH: ${{ matrix.arch.architecture }} CGO_ENABLED: 0 + GOPRIVATE: github.com/joho/godotenv run: | apt-get update apt-get install -q -y curl wget git @@ -56,7 +57,7 @@ jobs: go env printf "\n\nSystem environment:\n\n" env - go get -insecure -v -t -d ./... + go get -v -t -d ./... go test ./... cd ./cmd/godotenv go build -trimpath -ldflags="-w -s" -v \ No newline at end of file From e74c6cadd5d7f26640f54278dc2ac083d639c505 Mon Sep 17 00:00:00 2001 From: Oleksandr Redko Date: Mon, 25 Apr 2022 07:35:55 +0300 Subject: [PATCH 02/14] Fix typos in comments and extend README (#177) --- README.md | 6 +++--- godotenv.go | 4 ++-- godotenv_test.go | 6 +++--- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 1ec45b2..01bc695 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # GoDotEnv ![CI](https://github.com/joho/godotenv/workflows/CI/badge.svg) [![Go Report Card](https://goreportcard.com/badge/github.com/joho/godotenv)](https://goreportcard.com/report/github.com/joho/godotenv) -A Go (golang) port of the Ruby dotenv project (which loads env vars from a .env file) +A Go (golang) port of the Ruby [dotenv](https://github.com/bkeepers/dotenv) project (which loads env vars from a .env file). From the original Library: @@ -8,9 +8,9 @@ From the original Library: > > But it is not always practical to set environment variables on development machines or continuous integration servers where multiple projects are run. Dotenv load variables from a .env file into ENV when the environment is bootstrapped. -It can be used as a library (for loading in env for your own daemons etc) or as a bin command. +It can be used as a library (for loading in env for your own daemons etc.) or as a bin command. -There is test coverage and CI for both linuxish and windows environments, but I make no guarantees about the bin version working on windows. +There is test coverage and CI for both linuxish and Windows environments, but I make no guarantees about the bin version working on Windows. ## Installation diff --git a/godotenv.go b/godotenv.go index 466f2eb..975d7bc 100644 --- a/godotenv.go +++ b/godotenv.go @@ -1,6 +1,6 @@ // Package godotenv is a go port of the ruby dotenv library (https://github.com/bkeepers/dotenv) // -// Examples/readme can be found on the github page at https://github.com/joho/godotenv +// Examples/readme can be found on the GitHub page at https://github.com/joho/godotenv // // The TL;DR is that you make a .env file that looks something like // @@ -61,7 +61,7 @@ func Load(filenames ...string) (err error) { // // godotenv.Overload("fileone", "filetwo") // -// It's important to note this WILL OVERRIDE an env variable that already exists - consider the .env file to forcefilly set all vars. +// It's important to note this WILL OVERRIDE an env variable that already exists - consider the .env file to forcefully set all vars. func Overload(filenames ...string) (err error) { filenames = filenamesOrDefault(filenames) diff --git a/godotenv_test.go b/godotenv_test.go index 7274c14..49f6fe0 100644 --- a/godotenv_test.go +++ b/godotenv_test.go @@ -131,7 +131,7 @@ func TestLoadDoesNotOverride(t *testing.T) { loadEnvAndCompareValues(t, Load, envFileName, expectedValues, presets) } -func TestOveroadDoesOverride(t *testing.T) { +func TestOverloadDoesOverride(t *testing.T) { envFileName := "fixtures/plain.env" // ensure NO overload @@ -325,11 +325,11 @@ func TestParsing(t *testing.T) { // expect(env('FOO="bar\nbaz"')).to eql('FOO' => "bar\nbaz") parseAndCompare(t, `FOO="bar\nbaz"`, "FOO", "bar\nbaz") - // it 'parses varibales with "." in the name' do + // it 'parses variables with "." in the name' do // expect(env('FOO.BAR=foobar')).to eql('FOO.BAR' => 'foobar') parseAndCompare(t, "FOO.BAR=foobar", "FOO.BAR", "foobar") - // it 'parses varibales with several "=" in the value' do + // it 'parses variables with several "=" in the value' do // expect(env('FOO=foobar=')).to eql('FOO' => 'foobar=') parseAndCompare(t, "FOO=foobar=", "FOO", "foobar=") From 139777a9ff60fa4bc9e57219047564dd92f67507 Mon Sep 17 00:00:00 2001 From: John Barton Date: Sun, 12 Jun 2022 13:56:53 +1200 Subject: [PATCH 03/14] remove power8 tests as they stopped working --- .github/workflows/ci.yml | 43 ---------------------------------------- 1 file changed, 43 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index e96faf7..2a96fc2 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -18,46 +18,3 @@ jobs: with: go-version: ${{ matrix.go }} - run: go test - - test-non-amd64: - strategy: - fail-fast: false - matrix: - arch: - # For some reasons this is segfaulting on go env - # - name: IBM Z and LinuxONE - # architecture: "s390x" - - name: POWER8 - architecture: "ppc64le" - - runs-on: ubuntu-latest - name: Test on ${{ matrix.arch.name }} - steps: - - uses: actions/checkout@v2 - - uses: uraimo/run-on-arch-action@master - with: - arch: ${{ matrix.arch.architecture }} - distro: ubuntu20.04 - env: | # YAML pipe - GOARCH: ${{ matrix.arch.architecture }} - CGO_ENABLED: 0 - GOPRIVATE: github.com/joho/godotenv - run: | - apt-get update - apt-get install -q -y curl wget git - latestGo=$(curl "https://golang.org/VERSION?m=text") - wget "https://dl.google.com/go/${latestGo}.linux-${GOARCH}.tar.gz" - rm -f $(which go) - rm -rf /usr/local/go - tar -C /usr/local -xzf "${latestGo}.linux-${GOARCH}.tar.gz" - export PATH=/usr/local/go/bin:$PATH - printf "Using go at: $(which go)\n" - printf "Go version: $(go version)\n" - printf "\n\nGo environment:\n\n" - go env - printf "\n\nSystem environment:\n\n" - env - go get -v -t -d ./... - go test ./... - cd ./cmd/godotenv - go build -trimpath -ldflags="-w -s" -v \ No newline at end of file From 76d246ae25b0e765ae06981e3ffa12d6fb392400 Mon Sep 17 00:00:00 2001 From: John Barton Date: Sun, 12 Jun 2022 13:57:20 +1200 Subject: [PATCH 04/14] Add a few new go versions --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 2a96fc2..1265249 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -8,7 +8,7 @@ jobs: strategy: fail-fast: false matrix: - go: [ '1.15', '1.14' ] + go: [ '1.18', '1.17', '1.16', '1.15' ] os: [ ubuntu-latest, macOS-latest, windows-latest ] name: ${{ matrix.os }} Go ${{ matrix.go }} Tests steps: From 26b87a7e2c507194061c8d5b2dc46be0c3c05e98 Mon Sep 17 00:00:00 2001 From: Bahtiyar Biksayev Date: Sun, 12 Jun 2022 05:06:04 +0300 Subject: [PATCH 05/14] Update README for go install post go 1.17 (#170) * tune README * tune --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 01bc695..5abfaf5 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,12 @@ go get github.com/joho/godotenv ``` or if you want to use it as a bin command +go >= 1.17 +```shell +go install github.com/joho/godotenv/cmd/godotenv@latest +``` + +go < 1.17 ```shell go get github.com/joho/godotenv/cmd/godotenv ``` From a582f0c9d34ad0d898a1b0261e9b2d2148dd61eb Mon Sep 17 00:00:00 2001 From: John Barton Date: Sun, 12 Jun 2022 15:04:14 +1200 Subject: [PATCH 06/14] Remove renovate, add dependabot (#183) --- .github/dependabot.yml | 10 ++++++++++ renovate.json | 5 ----- 2 files changed, 10 insertions(+), 5 deletions(-) create mode 100644 .github/dependabot.yml delete mode 100644 renovate.json diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..6151c64 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,10 @@ +version: 2 +updates: + - package-ecosystem: "gomod" + directory: / + schedule: + interval: "daily" + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "daily" \ No newline at end of file diff --git a/renovate.json b/renovate.json deleted file mode 100644 index f45d8f1..0000000 --- a/renovate.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "extends": [ - "config:base" - ] -} From a904479007e635a5c2d35a512f890cd62e915cfd Mon Sep 17 00:00:00 2001 From: John Barton Date: Sun, 12 Jun 2022 15:09:09 +1200 Subject: [PATCH 07/14] Create codeql-analysis.yml (#186) --- .github/workflows/codeql-analysis.yml | 72 +++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 .github/workflows/codeql-analysis.yml diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml new file mode 100644 index 0000000..db5c760 --- /dev/null +++ b/.github/workflows/codeql-analysis.yml @@ -0,0 +1,72 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: "CodeQL" + +on: + push: + branches: [ "main" ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ "main" ] + schedule: + - cron: '31 4 * * 2' + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + strategy: + fail-fast: false + matrix: + language: [ 'go' ] + # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] + # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v2 + with: + languages: ${{ matrix.language }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + + # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs + # queries: security-extended,security-and-quality + + + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@v2 + + # ℹī¸ Command-line programs to run using the OS shell. + # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun + + # If the Autobuild fails above, remove it and uncomment the following three lines. + # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. + + # - run: | + # echo "Run, Build Application using script" + # ./location_of_script_within_repo/buildscript.sh + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v2 From aa20cd96bbf46b9a12cd62e1227032e621b56bab Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sun, 12 Jun 2022 15:16:09 +1200 Subject: [PATCH 08/14] Bump actions/checkout from 2 to 3 (#184) Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 3. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v2...v3) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/ci.yml | 2 +- .github/workflows/release.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 1265249..ee21197 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -12,7 +12,7 @@ jobs: os: [ ubuntu-latest, macOS-latest, windows-latest ] name: ${{ matrix.os }} Go ${{ matrix.go }} Tests steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Setup go uses: actions/setup-go@v2 with: diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index dc2c692..63f404e 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -11,7 +11,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout code - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Generate build files uses: thatisuday/go-cross-build@v1 with: From 60df7dd66c53bacab0ef2f17d0eb164b085f3392 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sun, 12 Jun 2022 15:40:02 +1200 Subject: [PATCH 09/14] Bump actions/setup-go from 2 to 3 (#185) Bumps [actions/setup-go](https://github.com/actions/setup-go) from 2 to 3. - [Release notes](https://github.com/actions/setup-go/releases) - [Commits](https://github.com/actions/setup-go/compare/v2...v3) --- updated-dependencies: - dependency-name: actions/setup-go dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index ee21197..c740ad0 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -14,7 +14,7 @@ jobs: steps: - uses: actions/checkout@v3 - name: Setup go - uses: actions/setup-go@v2 + uses: actions/setup-go@v3 with: go-version: ${{ matrix.go }} - run: go test From b898a8b0d161e534e1e43deea9af9edb39bd0e0c Mon Sep 17 00:00:00 2001 From: Elliot Murphy Date: Sat, 11 Jun 2022 20:43:35 -0700 Subject: [PATCH 10/14] Add darwin arm64 build (#174) * Add darwin arm64 build Signed-off-by: Elliot Murphy * update url for go version Signed-off-by: Elliot Murphy Co-authored-by: John Barton --- .github/workflows/ci.yml | 43 +++++++++++++++++++++++++++++++++++ .github/workflows/release.yml | 5 ++-- 2 files changed, 45 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index c740ad0..3eb00b4 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -18,3 +18,46 @@ jobs: with: go-version: ${{ matrix.go }} - run: go test + + test-non-amd64: + strategy: + fail-fast: false + matrix: + arch: + # For some reasons this is segfaulting on go env + # - name: IBM Z and LinuxONE + # architecture: "s390x" + - name: POWER8 + architecture: "ppc64le" + + runs-on: ubuntu-latest + name: Test on ${{ matrix.arch.name }} + steps: + - uses: actions/checkout@v2 + - uses: uraimo/run-on-arch-action@master + with: + arch: ${{ matrix.arch.architecture }} + distro: ubuntu20.04 + env: | # YAML pipe + GOARCH: ${{ matrix.arch.architecture }} + CGO_ENABLED: 0 + GOPRIVATE: github.com/joho/godotenv + run: | + apt-get update + apt-get install -q -y curl wget git + latestGo=$(curl "https://go.dev/VERSION?m=text") + wget "https://dl.google.com/go/${latestGo}.linux-${GOARCH}.tar.gz" + rm -f $(which go) + rm -rf /usr/local/go + tar -C /usr/local -xzf "${latestGo}.linux-${GOARCH}.tar.gz" + export PATH=/usr/local/go/bin:$PATH + printf "Using go at: $(which go)\n" + printf "Go version: $(go version)\n" + printf "\n\nGo environment:\n\n" + go env + printf "\n\nSystem environment:\n\n" + env + go get -v -t -d ./... + go test ./... + cd ./cmd/godotenv + go build -trimpath -ldflags="-w -s" -v diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 63f404e..e378b78 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -13,9 +13,9 @@ jobs: - name: Checkout code uses: actions/checkout@v3 - name: Generate build files - uses: thatisuday/go-cross-build@v1 + uses: thatisuday/go-cross-build@v1.0.2 with: - platforms: 'linux/amd64, linux/ppc64le, darwin/amd64, windows/amd64' + platforms: 'linux/amd64, linux/ppc64le, darwin/amd64, darwin/arm64, windows/amd64' package: 'cmd/godotenv' name: 'godotenv' compress: 'true' @@ -29,4 +29,3 @@ jobs: file: dist/* file_glob: true overwrite: true - \ No newline at end of file From 1b6c7eb7cc42ec229a2839949353101b0e2938e3 Mon Sep 17 00:00:00 2001 From: John Barton Date: Sun, 12 Jun 2022 15:39:28 +1200 Subject: [PATCH 11/14] README updates around contributing --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5abfaf5..991f9c0 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,7 @@ go get github.com/joho/godotenv ``` or if you want to use it as a bin command + go >= 1.17 ```shell go install github.com/joho/godotenv/cmd/godotenv@latest @@ -169,9 +170,17 @@ content, err := godotenv.Marshal(env) ## Contributing -Contributions are most welcome! The parser itself is pretty stupidly naive and I wouldn't be surprised if it breaks with edge cases. +Contributions are welcome, but with some caveats. -*code changes without tests will not be accepted* +This library has been declared feature complete (see [#182](https://github.com/joho/godotenv/issues/182) for background) and will not be accepting issues or pull requests adding new functionality or breaking the library API. + +Contributions would be gladly accepted that: + +* bring this library's parsing into closer compatibility with the mainline dotenv implementations, in particular [Ruby's dotenv](https://github.com/bkeepers/dotenv) and [Node.js' dotenv](https://github.com/motdotla/dotenv) +* keep the library up to date with the go ecosystem (ie CI bumps, documentation changes, changes in the core libraries) +* bug fixes for use cases that pertain to the library's purpose of easing development of codebases deployed into twelve factor environments + +*code changes without tests and references to peer dotenv implementations will not be accepted* 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`) @@ -185,10 +194,6 @@ Releases should follow [Semver](http://semver.org/) though the first couple of r Use [annotated tags for all releases](https://github.com/joho/godotenv/issues/30). Example `git tag -a v1.2.1` -## CI - -Linux: [![Build Status](https://travis-ci.org/joho/godotenv.svg?branch=master)](https://travis-ci.org/joho/godotenv) Windows: [![Build status](https://ci.appveyor.com/api/projects/status/9v40vnfvvgde64u4)](https://ci.appveyor.com/project/joho/godotenv) - ## Who? The original library [dotenv](https://github.com/bkeepers/dotenv) was written by [Brandon Keepers](http://opensoul.org/), and this port was done by [John Barton](https://johnbarton.co/) based off the tests/fixtures in the original library. From add39c6f94ba6aedc178b80b33eb9f2d6ae8f2ec Mon Sep 17 00:00:00 2001 From: John Barton Date: Sun, 12 Jun 2022 15:47:52 +1200 Subject: [PATCH 12/14] Remove power8 again as it wasn't fixed --- .github/workflows/ci.yml | 43 ---------------------------------------- 1 file changed, 43 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 3eb00b4..c740ad0 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -18,46 +18,3 @@ jobs: with: go-version: ${{ matrix.go }} - run: go test - - test-non-amd64: - strategy: - fail-fast: false - matrix: - arch: - # For some reasons this is segfaulting on go env - # - name: IBM Z and LinuxONE - # architecture: "s390x" - - name: POWER8 - architecture: "ppc64le" - - runs-on: ubuntu-latest - name: Test on ${{ matrix.arch.name }} - steps: - - uses: actions/checkout@v2 - - uses: uraimo/run-on-arch-action@master - with: - arch: ${{ matrix.arch.architecture }} - distro: ubuntu20.04 - env: | # YAML pipe - GOARCH: ${{ matrix.arch.architecture }} - CGO_ENABLED: 0 - GOPRIVATE: github.com/joho/godotenv - run: | - apt-get update - apt-get install -q -y curl wget git - latestGo=$(curl "https://go.dev/VERSION?m=text") - wget "https://dl.google.com/go/${latestGo}.linux-${GOARCH}.tar.gz" - rm -f $(which go) - rm -rf /usr/local/go - tar -C /usr/local -xzf "${latestGo}.linux-${GOARCH}.tar.gz" - export PATH=/usr/local/go/bin:$PATH - printf "Using go at: $(which go)\n" - printf "Go version: $(go version)\n" - printf "\n\nGo environment:\n\n" - go env - printf "\n\nSystem environment:\n\n" - env - go get -v -t -d ./... - go test ./... - cd ./cmd/godotenv - go build -trimpath -ldflags="-w -s" -v From 85a22371267105132a9ef0393ff91c33ca694f9d Mon Sep 17 00:00:00 2001 From: Doarakko <2wua4nlyi@gmail.com> Date: Mon, 12 Sep 2022 15:55:41 +0900 Subject: [PATCH 13/14] sort go import in readme (#193) --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 991f9c0..0f170cb 100644 --- a/README.md +++ b/README.md @@ -47,9 +47,10 @@ Then in your Go app you can do something like package main import ( - "github.com/joho/godotenv" "log" "os" + + "github.com/joho/godotenv" ) func main() { From 5c76d3e02c63f90a1bfae60738bbc24ba16f05c4 Mon Sep 17 00:00:00 2001 From: John Barton Date: Sun, 30 Oct 2022 12:38:35 +1100 Subject: [PATCH 14/14] Add punctuation to please godoc (#197) Fixes issue reported over at https://github.com/golang/go/issues/55888 --- godotenv.go | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/godotenv.go b/godotenv.go index 975d7bc..6edd15d 100644 --- a/godotenv.go +++ b/godotenv.go @@ -30,15 +30,15 @@ const doubleQuoteSpecialChars = "\\\n\r\"!$`" // Load will read your env file(s) and load them into ENV for this process. // -// Call this function as close as possible to the start of your program (ideally in main) +// Call this function as close as possible to the start of your program (ideally in main). // -// If you call Load without any args it will default to loading .env in the current path +// If you call Load without any args it will default to loading .env in the current path. // -// You can otherwise tell it which files to load (there can be more than one) like +// You can otherwise tell it which files to load (there can be more than one) like: // // godotenv.Load("fileone", "filetwo") // -// It's important to note that it WILL NOT OVERRIDE an env variable that already exists - consider the .env file to set dev vars or sensible defaults +// It's important to note that it WILL NOT OVERRIDE an env variable that already exists - consider the .env file to set dev vars or sensible defaults. func Load(filenames ...string) (err error) { filenames = filenamesOrDefault(filenames) @@ -53,11 +53,11 @@ func Load(filenames ...string) (err error) { // Overload will read your env file(s) and load them into ENV for this process. // -// Call this function as close as possible to the start of your program (ideally in main) +// Call this function as close as possible to the start of your program (ideally in main). // -// If you call Overload without any args it will default to loading .env in the current path +// If you call Overload without any args it will default to loading .env in the current path. // -// You can otherwise tell it which files to load (there can be more than one) like +// You can otherwise tell it which files to load (there can be more than one) like: // // godotenv.Overload("fileone", "filetwo") // @@ -124,7 +124,7 @@ func Parse(r io.Reader) (envMap map[string]string, err error) { return } -//Unmarshal reads an env file from a string, returning a map of keys and values. +// Unmarshal reads an env file from a string, returning a map of keys and values. func Unmarshal(str string) (envMap map[string]string, err error) { return Parse(strings.NewReader(str)) } @@ -132,7 +132,7 @@ func Unmarshal(str string) (envMap map[string]string, err error) { // Exec loads env vars from the specified filenames (empty map falls back to default) // then executes the cmd specified. // -// Simply hooks up os.Stdin/err/out to the command and calls Run() +// Simply hooks up os.Stdin/err/out to the command and calls Run(). // // If you want more fine grained control over your command it's recommended // that you use `Load()` or `Read()` and the `os/exec` package yourself. @@ -146,7 +146,7 @@ func Exec(filenames []string, cmd string, cmdArgs []string) error { return command.Run() } -// Write serializes the given environment and writes it to a file +// Write serializes the given environment and writes it to a file. func Write(envMap map[string]string, filename string) error { content, err := Marshal(envMap) if err != nil {