Skip to content

Commit

Permalink
Update Workflow and Documentation (#14)
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelCduBois authored Jan 3, 2025
2 parents 57ab64a + e071b05 commit 82a7c9b
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 4 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Extract Metadata
id: leagueify-account-meta
id: metadata
uses: docker/metadata-action@369eb591f429131d6889c46b94e711f089e6ca96
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
Expand All @@ -34,4 +34,4 @@ jobs:
with:
context: .
push: true
tags: ${{ steps.leagueify-account-meta.outputs.tags }}
tags: ${{ steps.metadata.outputs.tags }}
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,9 @@ make clean
```

The Leagueify account service is ready for development once the banner output is
visible within the terminal. The banner blelow was created using the
visible within the terminal. By default the Leagueify account service api docs
are accessible at [http://localhost:6501/account/docs][service-url]. The banner
below was created using the
[Text to ASCII Art Generator by Patorjk][patorjk-taag].

```
Expand All @@ -59,3 +61,4 @@ leagueify-account-1 |
[go-download]: https://go.dev/dl/
[patorjk-taag]: https://patorjk.com/software/taag/#p=display&f=Kban&t=LEAGUEIFY%0AACCOUNT
[repo-makefile]: ./Makefile
[service-url]: http://localhost:6501/account/docs
6 changes: 5 additions & 1 deletion handler/docs/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,11 @@ info:

servers:
- url: http://localhost:6501/account
description: Local Docker Development
description: DIRECT -- Local Docker Development
- url: http://localhost/account
description: PROXY -- Local Docker Development
- url: http://localhost/api/account
description: PREFIX PROXY -- Local Docker Development

paths:
/healthz:
Expand Down

0 comments on commit 82a7c9b

Please sign in to comment.