Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#62: add option for specifying image #64

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

#62: add option for specifying image #64

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2ae9a45
#62: add option for specifying image
Sam-Bate-ITV Oct 25, 2024
4639b45
apply suggested change
Sam-Bate-ITV Dec 9, 2024
812452b
use docker hub for CI
Sam-Bate-ITV Dec 9, 2024
1f93cb7
change README based on PR review
Sam-Bate-ITV Dec 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,5 @@ jobs:
- name: Start MongoDB Server
uses: ./
with:
mongodb-image: 'public.ecr.aws/docker/library/mongo'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would like to avoid adding the mongodb-image configuration to all GitHub Action workflows. It would be good if we add a new workflow file using the ECR registry.

@Sam-Bate-ITV Sam, can you please remove all the added mongodb-image configs from the existing workflow YAML files and add a workflow. The new workflow file should be a copy of the test-single-instance.yml that uses a custom image.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've reverted this to use the default from docker hub. Of course this may impact the workflow from completing

mongodb-version: ${{ matrix.mongodb-version }}
1 change: 1 addition & 0 deletions .github/workflows/test-auth.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ jobs:
- name: Start MongoDB Server v${{ matrix.mongodb-version }}
uses: ./
with:
mongodb-image: 'public.ecr.aws/docker/library/mongo'
mongodb-version: ${{ matrix.mongodb-version }}
mongodb-db: ${{ matrix.mongodb-db }}
mongodb-username: ${{ matrix.mongodb-username }}
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/test-replica-set.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ jobs:
- name: Start MongoDB Server v${{ matrix.mongodb-version }}
uses: ./
with:
mongodb-image: 'public.ecr.aws/docker/library/mongo'
mongodb-version: ${{ matrix.mongodb-version }}
mongodb-replica-set: mongodb-test-rs

Expand Down
1 change: 1 addition & 0 deletions .github/workflows/test-single-instance.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ jobs:
- name: Start MongoDB Server v${{ matrix.mongodb-version }}
uses: ./
with:
mongodb-image: 'public.ecr.aws/docker/library/mongo'
mongodb-version: ${{ matrix.mongodb-version }}

- name: Use Node.js ${{ matrix.node-version }}
Expand Down
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ jobs:
- 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'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please make the option to use a custom MongoDB docker image a new section in the README.md. Please create a section like here https://github.com/supercharge/redis-github-action/blob/main/README.md#using-a-custom-redis-image

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

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

- run: npm install
Expand Down
2 changes: 2 additions & 0 deletions action-types.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# See https://github.com/krzema12/github-actions-typing
inputs:
mongodb-image:
type: string
mongodb-version:
type: string
mongodb-replica-set:
Expand Down
6 changes: 6 additions & 0 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ branding:
color: 'green'

inputs:
mongodb-image:
description: 'MongoDB image to use (defaults to using "mongo" from Docker Hub but you could also use an image from another repository such as Amazons "public.ecr.aws/docker/library/mongo")'
required: false
default: 'mongo'

mongodb-version:
description: 'MongoDB version to use (default "latest")'
required: false
Expand Down Expand Up @@ -45,6 +50,7 @@ runs:
using: 'docker'
image: 'Dockerfile'
args:
- ${{ inputs.mongodb-image }}
- ${{ inputs.mongodb-version }}
- ${{ inputs.mongodb-replica-set }}
- ${{ inputs.mongodb-port }}
Expand Down
27 changes: 18 additions & 9 deletions start-mongodb.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,25 @@
#!/bin/sh

# Map input values from the GitHub Actions workflow to shell variables
MONGODB_VERSION=$1
MONGODB_REPLICA_SET=$2
MONGODB_PORT=$3
MONGODB_DB=$4
MONGODB_USERNAME=$5
MONGODB_PASSWORD=$6
MONGODB_CONTAINER_NAME=$7
MONGODB_IMAGE=$1
MONGODB_VERSION=$2
MONGODB_REPLICA_SET=$3
MONGODB_PORT=$4
MONGODB_DB=$5
MONGODB_USERNAME=$6
MONGODB_PASSWORD=$7
MONGODB_CONTAINER_NAME=$8

# `mongosh` is used starting from MongoDB 5.x
MONGODB_CLIENT="mongosh --quiet"

if [ -z "$MONGODB_IMAGE" ]; then
echo ""
echo "Missing MongoDB image in the [mongodb-image] input. Received value: $MONGODB_IMAGE"
echo ""

exit 2
fi

if [ -z "$MONGODB_VERSION" ]; then
echo ""
Expand All @@ -21,6 +29,7 @@ if [ -z "$MONGODB_VERSION" ]; then
exit 2
fi

echo "::group::Using mogo image $MONGODB_IMAGE:$MONGODB_VERSION"
Sam-Bate-ITV marked this conversation as resolved.
Show resolved Hide resolved

echo "::group::Selecting correct MongoDB client"
if [ "`echo $MONGODB_VERSION | cut -c 1`" -le "4" ]; then
Expand Down Expand Up @@ -83,7 +92,7 @@ if [ -z "$MONGODB_REPLICA_SET" ]; then
echo " - container-name [$MONGODB_CONTAINER_NAME]"
echo ""

docker run --name $MONGODB_CONTAINER_NAME --publish $MONGODB_PORT:$MONGODB_PORT -e MONGO_INITDB_DATABASE=$MONGODB_DB -e MONGO_INITDB_ROOT_USERNAME=$MONGODB_USERNAME -e MONGO_INITDB_ROOT_PASSWORD=$MONGODB_PASSWORD --detach mongo:$MONGODB_VERSION --port $MONGODB_PORT
docker run --name $MONGODB_CONTAINER_NAME --publish $MONGODB_PORT:$MONGODB_PORT -e MONGO_INITDB_DATABASE=$MONGODB_DB -e MONGO_INITDB_ROOT_USERNAME=$MONGODB_USERNAME -e MONGO_INITDB_ROOT_PASSWORD=$MONGODB_PASSWORD --detach $MONGODB_IMAGE:$MONGODB_VERSION --port $MONGODB_PORT

if [ $? -ne 0 ]; then
echo "Error starting MongoDB Docker container"
Expand All @@ -104,7 +113,7 @@ echo " - replica set [$MONGODB_REPLICA_SET]"
echo ""


docker run --name $MONGODB_CONTAINER_NAME --publish $MONGODB_PORT:$MONGODB_PORT --detach mongo:$MONGODB_VERSION --port $MONGODB_PORT --replSet $MONGODB_REPLICA_SET
docker run --name $MONGODB_CONTAINER_NAME --publish $MONGODB_PORT:$MONGODB_PORT --detach $MONGODB_IMAGE:$MONGODB_VERSION --port $MONGODB_PORT --replSet $MONGODB_REPLICA_SET

if [ $? -ne 0 ]; then
echo "Error starting MongoDB Docker container"
Expand Down