GitHub Actions with Remix
Learn how to configure GitHub Actions with Dotenv Vault for a Remix application. This tutorial assumes you have already created a .env
file and synced it.
You can find a complete example repo here.
1. Add GitHub Actions yaml file
In your Remix project add the file .github/workflows/main.yml.
# .github/workflow/main.yml
name: npm run build
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/[email protected]
- uses: actions/[email protected]
with:
node-version: 16
- run: npm install
- run: npm run build
env:
DOTENV_KEY: ${{ secrets.DOTENV_KEY }}
2. Require dotenv-vault
Install dotenv-vault
$ npm install dotenv-vault-core --save
And add it to remix.config.js.
// remix.config.js
require('dotenv-vault').config()
console.log(process.env) // for debugging purposes. remove when ready.
module.exports = {
...
};
3. Run dotenv-vault build
Run npx dotenv-vault build to build your encrypted .env.vault file.
$ npx dotenv-vault build
4. Get DOTENV_KEY
Run npx dotenv-vault keys ci.
$ npx dotenv-vault keys ci
remote: Listing .env.vault decryption keys... done
dotenv://:[email protected]/vault/.env.vault?environment=ci
5. Set DOTENV_KEY
Visit your GitHub Project > Settings > Secrets > Actions and click ‘New Repository Secret’.
Set DOTENV_KEY to the value returned in step 4.
6. Commit and push
That’s it!
Commit those changes safely to code and push to GitHub.
When the CI runs, it will recognize the DOTENV_KEY
, decrypt the .env.vault file, and load the CI environment variables to ENV
. If a DOTENV_KEY
is not set (like during development on your local machine) it will fall back to regular dotenv.
You will know it worked when you see the message ‘Loading env from encrypted .env.vault’.