dotenv-configserver

KO | EN

gitlite — search

#python #hacktoberfest #react #go #golang #android #deep-learning #docker #nodejs #java #cli #security #ios #openai

dotenv-configserver

(★ 13)

Load dotenv files to GITHUB_ENV from remote repository

dotenv-configserver Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Environment variables from a remote (centralized) config server

Loads dotenv (.env) files content from a remote repository to `GITHUB_ENV` and `outputs`.
This action can be used like a [config server](https://cloud.spring.io/spring-cloud-config/reference/html/) but for your Github actions.

**This action can work as a workaround if you do not beneficiate of [Github Environments](https://docs.github.com/en/actions/deployment/environments) feature in your Github plan**
Common example: your enterprise is using Github Teams plan and private repositories.

[Environment variables](https://docs.github.com/en/actions/reference/environment-variables#about-environment-variables) will be then available using `${{ env.<KEY> }}` within the same job. 
[Outputs](https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#needs-context) will be then available using `${{ <job id>.outputs.<output name> }}` for other jobs.

## Configuration

| Parameter | Required | Description | Example |
|:-----------:|:--------:|----------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| repository | true | The remote repository (configserver). Format: `<owner>/<repo>` | `repository: "Steph0/dotenv-configserver"` |
| token | false | This should be a token with access to your repository scoped in as a secret (default to GITHUB_TOKEN) | `token: ${{ secrets.GITHUB_TOKEN }}` |
| branch | false | The remote branch to checkout (default: main) | `branch: "staging"` |
| destination | false | The working folder to write configuration to (default 'RUNNER_TEMP') | `destination: "/my/dest/folder"` |
| directory | false | Look for file in configserver subdirectory (default '.'). Useful if your configserver hosts several config directories in it | `directory: "my-app-dir"` |
| filename | false | The config filename (default to '.env') | `filename: "my-application.env"` |
| profile | false | Profile for file (ex: 'prod' will make tool look for <filename_part>-<profile>.<filename_extension>) If empty, won't apply. | `profile: "prod"` Depending on filename will make action look for file: `my-application-prod.env` |
| cleanup | false | If false, won't delete configuration files downloaded after loading to GITHUB_ENV (default: true) | `cleanup: false` |

## Usage

This action allows many directories structures in your configserver.

This section illustrates common configserver configurations that could be used for your projects/enterprise:

### Basic

Configserver:
<pre>
(main branch)
|_ .env
</pre>

Github Action:

```yaml
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      -   name: "Checkout"
          id: checkout
          uses: actions/checkout3

- name: "Launch action"
        uses: Steph0/dotenv-configserver
        with:
          repository: "Steph0/test-configserver"
          token: "${{ secrets.ACTION_TOKEN }}"
      
      # You should see your .env config in 'env'
      - name: "See exported values"
        run: env
```

### Flat

Configserver:

<pre>
(main branch)
|_ dev.env
|_ staging.env
|_ prod.env
</pre>

Github Action:

```yaml
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      -   name: "Checkout"
          id: checkout
          uses: actions/checkout3

- name: "Launch action"
        uses: Steph0/dotenv-configserver
        with:
          repository: "Steph0/test-configserver"
          token: "${{ secrets.ACTION_TOKEN }}"
          # Will look for 'prod.env'
          profile: "prod"
      
      # You should see your .env config in 'env'
      - name: "See exported values"
        run: env
```

### Env per branch

Configserver:
<pre>
(main branch)
|_ .env

(dev branch)
|_ .env
</pre>

Github Action:

```yaml
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      -   name: "Checkout"
          id: checkout
          uses: actions/checkout@v3

### Nested directories

Configserver:
<pre>
(main branch)
|_ front
 |_ application-prod.env
|_ backend
 |_ application-prod.env

(dev branch)
|_ front
 |_ application-dev.env
|_ backend
 |_ application-dev.env
</pre>

Github Action:

```yaml
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      -   name: "Checkout"
          id: checkout
          uses: actions/checkout@v3

- name: "Launch action"
        uses: Steph0/dotenv-configserver
        with:
          repository: "Steph0/test-configserver"
          token: "${{ secrets.ACTION_TOKEN }}"
          # Will checkout 'dev' branch
          branch: "dev"
          # Look for backend conf
          directory: backend
          # Override default filename
          filename: "application" # or `application.env`
          # Insert profile in filename (eg: application-dev.env)
          profile: "dev"
      
      # You should see your .env config in 'env'
      - name: "See exported values"
        run: env
```

## Development

```bash
# Install dependencies
npm ci
# Build action
npm run all
```

You can test actions locally using [ACT](https://github.com/nektos/act).
Example:

```bash
# 'test.secrets' is a local file (automatically ignored) containing secrets like your Github PAT
npm run prepare && \
act workflow_dispatch -e ./.github/workflows/act-test.event -b --secret-file ./.github/workflows/test.secrets
```

## Inspiration

This project took great inspiration from:

* [xom9ikk/dotenv](https://github.com/xom9ikk/dotenv)
* [actions/checkout](https://github.com/actions/checkout)
* [spring-cloud-config](https://cloud.spring.io/spring-cloud-static/spring-cloud-config/1.3.2.RELEASE/#_locating_remote_configuration_resources)

Heavily based also on the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages).

## Contribute

Feel free to ask for support or features requests in the Issues tab of the project repository.

Contributions (bug fixes, new features) are welcomed!

License: MIT

dotenv-configserver

dotenv-configserver Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

dotenv-configserver

dotenv-configserver Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README