https://github.com/gullerya/db-setup-action
GitHub Action to automate local DB setup (Docker based)
https://github.com/gullerya/db-setup-action
Last synced: 2 months ago
JSON representation
GitHub Action to automate local DB setup (Docker based)
- Host: GitHub
- URL: https://github.com/gullerya/db-setup-action
- Owner: gullerya
- License: isc
- Created: 2021-04-05T19:16:30.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-05-05T19:03:53.000Z (about 4 years ago)
- Last Synced: 2025-02-02T11:43:36.719Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 122 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: license.md
Awesome Lists containing this project
README
# DB Setup action
[](https://github.com/gullerya/db-setup-action/actions/workflows/quality.yml)
`db-setup-action` automates setup of the chosen DB (Docker based, on host machine).
Currently supported (in alphabetical order):
- MariaDB
- MySQL
- PostgreSQL
- SQLServer
Installation uses official Docker images, see the links in per-DB sections below.
Purpose of this action:
- provide an easy and maximum possibly uniform setup of the DB server/s for tests automation
- enable relevant extensibility for the outstanders
- ensure the safest / best-practice defaults OOTB
> Attention: please review legal information links in per-DB sections below to ensure correct images usage.
## Inputs
| Key | Description |
|------------|-------------|
| `image` | the exact Docker image per DB (see the lists below, under each supported DB section) |
| `port` | port __of your choice__, that your application will be connecting to the DB through |
| `username` | sets up DB's admin username |
| `password` | sets up DB's admin password |
| `database` | database name, that will be created for your application's use |
> Attention: please review the per-DB sections below for any specifics or deviations of each.
---
## MariaDB
[Legal](https://mariadb.com/kb/en/mariadb-license/)
[Images/tags list](https://hub.docker.com/_/mariadb?tab=tags&page=1&ordering=last_updated)
### Usage example
```yml
name: Setup local MariaDB
uses: gullerya/[email protected]
with:
image: 'mariadb:latest'
port: 3306
username: mariadbuser
password: mariadbpass
database: testdb
```
### Specific remarks
MariaDB provides a superuser OOTB, `root`.
I've deliberately decided to NOT allow to use it, setting it's password to a random value.
Please, let me know if this is limiting a usage of the MariaDB essentially and should be reconsidered.
---
## MySQL
[Legal](https://www.mysql.com/about/legal/)
[Images/tags list](https://hub.docker.com/_/mysql?tab=tags&page=1&ordering=last_updated)
### Usage example
```yml
name: Setup local MySQL
uses: gullerya/[email protected]
with:
image: 'mysql:latest'
port: 3306
username: mysqluser
password: mysqlpass
database: testdb
```
### Specific remarks
MySQL provides a superuser OOTB, `root`.
I've deliberately decided to NOT allow to use it, setting it's password to a random value.
Please, let me know if this is limiting a usage of the MySQL essentially and should be reconsidered.
---
## PostgreSQL
[Legal](https://www.postgresql.org/about/licence/)
[Images/tags list](https://hub.docker.com/_/postgres?tab=tags&page=1&ordering=last_updated)
### Usage example
```yml
name: Setup local PostgreSQL
uses: gullerya/[email protected]
with:
image: 'postgres:alpine'
port: 5432
username: postgres
password: postgres
database: testdb
```
---
## SQLServer
[Legal](https://hub.docker.com/_/microsoft-mssql-server) - see the License section at the bottom
[Images/tags list](https://hub.docker.com/_/microsoft-mssql-server).
### Usage example
```yml
name: Setup SQLServer
uses: gullerya/[email protected]
env:
ACCEPT_EULA: 'Y'
with:
image: 'mcr.microsoft.com/mssql/server:2019-latest'
port: 1433
username: sa
password: Passw0rd
database: testdb
```
### Specific remarks
In case of SQLServer please pay attention to the following:
- you MUST set environment variable `ACCEPT_EULA=Y` to express your awareness of it
- SQLServer is explicitly and deliberately set up as 'Developer' edition, see more in the Legal link above
- the `username` MUST be `sa`
- the `password` MUST meet strength requirements as per [this documentation (scroll to the `SA_PASSWORD` section)](https://hub.docker.com/_/microsoft-mssql-server)
> Note: while the password strength may lead to use some special characters, it is better to avoid chars like `$`, `@` since they may cause misinterpretation issues during the docker execution. Let me know of any issue encounterd with this.