fix: Solve CI publish issue (#157)

* doc: Add workflow diagram

* Stop workflow if HTTP request fails

* chore: Test publish execution with branch push

* chore: Remove TODOs

* doc: Update Changelog and cabal version for new release

* doc: Update README

* doc: Update README with new badge

* doc: Update README for GH Actions workflow

* feat: Short -x for --example

Author: CristhianMotoche

.github/workflows/README.md

@@ -0,0 +1,22 @@
+# CI Workflows
+
+## Overview
+
+- [Build](build.yml)
+  - Build and test Haskell code
+- [Draft](draft.yml)
+  - Create a GH draft release with a static binary
+- [Release](release.yml)
+  - Upload the package and docs to Hackage (release candidate)
+
+## Events
+
+```mermaid
+graph LR
+    event[GH Event]-->|on push|Build
+    event-->|tag created|Draft
+    Draft-->|create draft release|End
+    event-->|release published|Release
+    Release-->|upload artifacts to Hackage (release candidate)|End
+    Build-->End
+```

.github/workflows/publish.yml

@@ -35,8 +35,9 @@ jobs:
         run: |
           SDIST_PATH=$(ls dist-newstyle/sdist/dotenv-*.tar.gz)
           curl -X POST \
+           --fail -i \
            -H 'Accept: text/plain' \
-           -H "Authorization: X-ApiKey \"$HACKAGE_API_KEY\"" \
+           -H "Authorization: X-ApiKey ${HACKAGE_API_KEY}" \
            --form "package=@${SDIST_PATH}" \
            "https://hackage.haskell.org/packages/candidates"
 
@@ -51,8 +52,9 @@ jobs:
           VERSION=${TAG_VERSION:1}
           DOCS_PATH=$(ls dist-newstyle/dotenv-*-docs.tar.gz)
           curl -X PUT \
+           --fail -i \
            -H 'Content-Type: application/x-tar' \
            -H 'Content-Encoding: gzip' \
-           -H "Authorization: X-ApiKey \"$HACKAGE_API_KEY\"" \
+           -H "Authorization: X-ApiKey ${HACKAGE_API_KEY}" \
            --data-binary "@${DOCS_PATH}" \
            "https://hackage.haskell.org/package/dotenv-$VERSION/candidate/docs"

CHANGELOG.md

@@ -1,4 +1,12 @@
 ## MASTER
+## Dotenv 0.10.1.0
+### Added
+* Short `-x` for `--example` flag
+
+### Modified
+* Fix `union`/`unionBy` bug, refactor .env.example check, and improve error
+message (Kudos to @pbrisbin)
+
 ## Dotenv 0.10.0.1
 ### Modified
 * Modify docs.

README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://github.com/stackbuilders/dotenv-hs/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/stackbuilders/dotenv-hs/actions/workflows/build-and-test.yml) [![Hackage](https://img.shields.io/hackage/v/dotenv.svg)](http://hackage.haskell.org/package/dotenv)
+[![Build Status](https://github.com/stackbuilders/dotenv-hs/actions/workflows/build.yml/badge.svg)](https://github.com/stackbuilders/dotenv-hs/actions/workflows/build.yml)[![Hackage](https://img.shields.io/hackage/v/dotenv.svg)](http://hackage.haskell.org/package/dotenv)
 
 # Dotenv files for Haskell
 
@@ -161,7 +161,7 @@ $ echo $FOO
 This will fail:
 ```shell
 $ dotenv -f .env --example .env.example "myprogram --myflag myargument"
-> dotenv: Missing env vars! Please, check (this/these) var(s) (is/are) set: BAR
+> dotenv: The following variables are present in .env.example, but not set in the current environment, or .env: BAR
 ```
 
 This will succeed:

app/Main.hs

@@ -62,6 +62,7 @@ config = Options
 
      <*> many (strOption (
                   long "example"
+                  <> short 'x'
                   <> metavar "DOTENV_EXAMPLE"
                   <> help "File to read for needed environmental variables" ))
 

dotenv.cabal

@@ -1,5 +1,5 @@
 name:                dotenv
-version:             0.10.0.1
+version:             0.10.1.0
 synopsis:            Loads environment variables from dotenv files
 homepage:            https://github.com/stackbuilders/dotenv-hs
 description:

src/Configuration/Dotenv.hs

@@ -79,7 +79,7 @@ loadFile config@Config {..} = do
           else error $ concat
             [ "The following variables are present in "
             , showPaths "one of " envExamples
-            , ", but not set in the current environment, or"
+            , ", but not set in the current environment, or "
             , showPaths "any of " envs
             , ": "
             , intercalate ", " missingKeys