diff --git a/.ghadocs.json b/.ghadocs.json index 8f0800f..ef434fd 100644 --- a/.ghadocs.json +++ b/.ghadocs.json @@ -10,8 +10,8 @@ "prefix": "v", "branch": "main" }, - "owner": "bitflight-devops", - "repo": "github-action-readme-generator", + "owner": "hoverkraft-tech", + "repo": "compose-action", "title_prefix": "GitHub Action: ", "prettier": true } diff --git a/.github/ghadocs/examples/branding.svg b/.github/ghadocs/examples/branding.svg new file mode 100644 index 0000000..824f22c --- /dev/null +++ b/.github/ghadocs/examples/branding.svg @@ -0,0 +1,6 @@ + + anchor + + + + \ No newline at end of file diff --git a/README.md b/README.md index 8187747..c69fd4c 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,70 @@
+ +branding<icon:anchor color:blue> + + +# branding<icon:anchor color:blue> GitHub Action: Docker Compose Action + - ---- + +Release%20by%20tagRelease%20by%20dateCommitOpen%20IssuesDownloads + +##
+ +Run your docker-compose file + + +```yaml +- uses: /@v1.0.0 + with: + # Description: Relative path to compose file(s). It can be a list of files. + # + # Default: ./docker-compose.yml + compose-file: "" + + # Description: Services to perform docker-compose up. + # + services: "" + + # Description: Additional options to pass to `docker-compose up` command. + # + # Default: + up-flags: "" + + # Description: Additional options to pass to `docker-compose down` command. + # + # Default: + down-flags: "" + + # Description: Additional options to pass to `docker-compose` command. + # + # Default: + compose-flags: "" +``` + + +| **Input** | **Description** | **Default** | **Required** | +| -------------------------- | ----------------------------------------------------------------------- | --------------------------------- | ------------ | +| compose-file | Relative path to compose file(s). It can be a list of files. | ./docker-compose.yml | **false** | +| services | Services to perform docker-compose up. | | **false** | +| up-flags | Additional options to pass to docker-compose up command. | | **false** | +| down-flags | Additional options to pass to docker-compose down command. | | **false** | +| compose-flags | Additional options to pass to docker-compose command. | | **false** | + diff --git a/action.yml b/action.yml index 7765e1d..e550be3 100644 --- a/action.yml +++ b/action.yml @@ -26,4 +26,4 @@ runs: post: "post.js" branding: icon: anchor - color: blue + color: gray-dark