Skip to content

Commit

Permalink
fix: update readme & pipeline
Browse files Browse the repository at this point in the history
  • Loading branch information
EyalPazz committed Sep 10, 2024
1 parent 623a295 commit 5a5f9c1
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 29 deletions.
23 changes: 0 additions & 23 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,26 +29,3 @@ jobs:
working-directory: tests/
run: go test

- name: Build binary
run: go build -o promoter

- name: Create Release
id: create_release
uses: actions/create-release@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tag_name: ${{ github.ref }}
release_name: Release ${{ github.ref }}
draft: false
prerelease: false

- name: Upload Release Asset
uses: actions/upload-release-asset@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
upload_url: ${{ steps.create_release.outputs.upload_url }}
asset_path: ./promoter
asset_name: promoter
asset_content_type: application/octet-stream
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ To promote a service to the production environment with the latest image tag, us
promoter --project <project_name> --service <service_name> --env production
```

To specify a custom image tag, use the --tag option:
To promote all services of a project to the production environment with the latest image tag, use:

```bash
promoter --project <project_name> --service <service_name> --env production --tag <image_tag>
promoter --project <project_name> --env production
```

## Configuration
Expand All @@ -29,9 +29,9 @@ Create a configuration file named .promoter.yaml in your home directory (~/.prom
```yaml
git-email: <Your Git Email>
git-name: <Your Git Name>
manifest-repo-url: <K8s/Helm Files Repo URL>
ssh-key-path: <GitHub SSH Key Path>
region: <AWS Region of Your ECR Repo>
manifest-repo-url: <Config Files Repo URL>
ssh-key-path: <Git SSH Key Path>
region: <Region of Your Container Registry>
```
Your manifest project structure should follow this format:
Expand All @@ -49,7 +49,7 @@ argo/

## To-Do List

- [ ] 1: Make Deployment Platform agnostic
- [x] 1: Make Deployment Platform agnostic
- [ ] 2: Add Tests
- [ ] 3: Expend to more providers and manifest repo structures
- [ ] 4: Write documentation

0 comments on commit 5a5f9c1

Please sign in to comment.