Skip to content

Commit

Permalink
Make all fields optional
Browse files Browse the repository at this point in the history
  • Loading branch information
michael-k committed Aug 23, 2023
1 parent 2accf99 commit beadff3
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ Start containers specified in a docker-compose file.

## Inputs

All inputs are optional, but either credentials for the Docker Hub or
Amazon Elastic Container Registry (Amazon ECR) are recommended to avoid
issues with rate limits.

### `docker-hub-username`

The username used for login to Docker Hub.
Expand Down Expand Up @@ -47,7 +51,8 @@ container must be named `db`.

### `working-directory`

**Optional** Specifies the working directory where the commands are run.
Specifies the working directory where the commands are run. Uses `./` by
default.


## Example usage
Expand Down
4 changes: 4 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@
inputs:
docker-hub-username:
description: Username for Docker Hub login
default: ''
docker-hub-access-token:
description: Access token for Docker Hub login
default: ''
aws-access-key-id:
description: Access key for AWS user with Amazon ECR access
default: ''
Expand All @@ -18,8 +20,10 @@ inputs:
default: ''
service-containers:
description: Service containers to start
default: ''
db-name:
description: Database name
default: ''
apply-migrations:
description: Set to true to apply migrations
required: false
Expand Down

0 comments on commit beadff3

Please # to comment.