https://github.com/supercharge/mongodb-github-action

Use MongoDB in GitHub Actions
https://github.com/supercharge/mongodb-github-action

github-actions github-actions-docker mongodb mongodb-server supercharge

Last synced: 4 days ago
JSON representation

Use MongoDB in GitHub Actions

• Host: GitHub
• URL: https://github.com/supercharge/mongodb-github-action
• Owner: supercharge
• License: mit
• Created: 2019-12-17T14:52:06.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2025-01-05T12:33:13.000Z (4 months ago)
• Last Synced: 2025-05-07T01:01:45.006Z (11 days ago)
• Topics: github-actions, github-actions-docker, mongodb, mongodb-server, supercharge
• Language: Shell
• Homepage:
• Size: 190 KB
• Stars: 241
• Watchers: 4
• Forks: 51
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

    

  

  


  


  


    

MongoDB in GitHub Actions

  

  


    Start a MongoDB server in your GitHub Actions.

  

  


  


    Usage

  

  


  


  


    Follow @marcuspoehls and @superchargejs for updates!

  



---

## Introduction

This GitHub Action starts a MongoDB server or MongoDB replica set. By default, the MongoDB server is available on the default port `27017`. You can configure a custom port using the `mongodb-port` input. The examples show how to use a custom port.

The MongoDB version must be specified using the `mongodb-version` input. The used version must exist in the published [`mongo` Docker hub tags](https://hub.docker.com/_/mongo?tab=tags). Default value is `latest`, other popular choices are `6.0`, `7.0` or even release candidates `8.0.0-rc4`.

This is useful when running tests against a MongoDB database.

## Usage

A code example says more than a 1000 words. Here’s an exemplary GitHub Action using a MongoDB server in different versions to test a Node.js app:

```yaml

name: Run tests

on: [push]

jobs:

  build:

    runs-on: ubuntu-latest

    strategy:

      matrix:

        node-version: [20.x, 22.x]

        mongodb-version: ['6.0', '7.0', '8.0']

    steps:

    - name: Git checkout

      uses: actions/checkout@v4

    - name: Use Node.js ${{ matrix.node-version }}

      uses: actions/setup-node@v4

      with:

        node-version: ${{ matrix.node-version }}

    - name: Start MongoDB

      uses: supercharge/[email protected]

      with:

        mongodb-version: ${{ matrix.mongodb-version }}

    - run: npm install

    - run: npm test

      env:

        CI: true

```

### Using a Custom MongoDB Port

You can start the MongoDB instance on a custom port. Use the `mongodb-port: 12345` input to configure port `12345` for MongoDB. Replace `12345` with the port you want to use in your test runs.

The following example starts a MongoDB server on port `42069`:

```yaml

name: Run tests

on: [push]

jobs:

  build:

    runs-on: ubuntu-latest

    strategy:

      matrix:

        node-version: [20.x, 22.x]

        mongodb-version: ['6.0', '7.0', '8.0']

    steps:

    - name: Git checkout

      uses: actions/checkout@v4

    - name: Use Node.js ${{ matrix.node-version }}

      uses: actions/setup-node@v4

      with:

        node-version: ${{ matrix.node-version }}

    - name: Start MongoDB

      uses: supercharge/[email protected]

      with:

        mongodb-version: ${{ matrix.mongodb-version }}

        mongodb-replica-set: test-rs

        mongodb-port: 42069

    - name: Install dependencies

      run: npm install

    - name: Run tests

      run: npm test

      env:

        CI: true

```

### With a Replica Set (MongoDB `--replSet` Flag)

You can run your tests against a MongoDB replica set by adding the `mongodb-replica-set: your-replicate-set-name` input in your action’s workflow. The value for `mongodb-replica-set` defines the name of your replica set. Replace `your-replicate-set-name` with the replica set name you want to use in your tests.

The following example uses the replica set name `test-rs`:

```yaml

name: Run tests

on: [push]

jobs:

  build:

    runs-on: ubuntu-latest

    strategy:

      matrix:

        node-version: [20.x, 22.x]

        mongodb-version: ['6.0', '7.0', '8.0']

    steps:

    - name: Git checkout

      uses: actions/checkout@v4

    - name: Use Node.js ${{ matrix.node-version }}

      uses: actions/setup-node@v4

      with:

        node-version: ${{ matrix.node-version }}

    - name: Start MongoDB

      uses: supercharge/[email protected]

      with:

        mongodb-version: ${{ matrix.mongodb-version }}

        mongodb-replica-set: test-rs

        mongodb-port: 42069

    - name: Install dependencies

      run: npm install

    - name: Run tests

      run: npm test

      env:

        CI: true

```

### With Authentication (MongoDB `--auth` Flag)

Setting the `mongodb-username` and `mongodb-password` inputs. As per the [Dockerhub documentation](https://hub.docker.com/_/mongo), this automatically creates an admin user and enables `--auth` mode.

The following example uses the username `supercharge`, password `secret` and also sets an initial `supercharge` database:

```yaml

name: Run tests with authentication

on: [push]

jobs:

  build:

    runs-on: ubuntu-latest

    strategy:

      matrix:

        node-version: [20.x, 22.x]

        mongodb-version: ['6.0', '7.0', '8.0']

    steps:

    - name: Git checkout

      uses: actions/checkout@v4

    - name: Use Node.js ${{ matrix.node-version }}

      uses: actions/setup-node@v4

      with:

        node-version: ${{ matrix.node-version }}

    - name: Start MongoDB

      uses: supercharge/[email protected]

      with:

        mongodb-version: ${{ matrix.mongodb-version }}

        mongodb-username: supercharge

        mongodb-password: secret

        mongodb-db: supercharge

    - name: Install dependencies

      run: npm install

    - name: Run tests

      run: npm test

      env:

        CI: true

```

### With Custom Container Name

The container name of the created MongoDB instance can be configured using the `mongodb-container-name` input

The following example will parameterize the MongoDB container name based on the `node-version` and `mongodb-version` being used from the matrix:

```yaml

name: Run with Custom Container Names

on: [push]

jobs:

  build:

    runs-on: ubuntu-latest

    strategy:

      matrix:

        node-version: [20.x, 22.x]

        mongodb-version: ['6.0', '7.0', '8.0']

    steps:

    - name: Git checkout

      uses: actions/checkout@v4

    - name: Use Node.js ${{ matrix.node-version }}

      uses: actions/setup-node@v4

      with:

        node-version: ${{ matrix.node-version }}

    - name: Start MongoDB

      uses: supercharge/[email protected]

      with:

        mongodb-version: ${{ matrix.mongodb-version }}

        mongodb-container-name: mongodb-${{ matrix.node-version }}-${{ matrix.mongodb-version }}

    - name: Install dependencies

      run: npm install

    - name: Run tests

      run: npm test

      env:

        CI: true

```

**Caveat:** due to [this issue](https://github.com/docker-library/mongo/issues/211), you **cannot enable user creation AND replica sets** initially. Therefore, if you use this action to setup a replica set, please create your users through a separate script.

### Using a Custom Mongo Image

You can utilize an alternative MongoDB docker image using the `mongodb-image` input:

```yaml

    - name: Start MongoDB

      uses: supercharge/[email protected]

      with:

        # Here we are using an image from Amazon's ECR rather than the default image from Docker Hub

        mongodb-image: 'public.ecr.aws/docker/library/mongo'

        mongodb-version: ${{ matrix.mongodb-version }}

```

## License

MIT © [Supercharge](https://superchargejs.com)

---

> [superchargejs.com](https://superchargejs.com)  · 

> GitHub [@supercharge](https://github.com/supercharge)  · 

> Twitter [@superchargejs](https://twitter.com/superchargejs)