staffbase / gitops-github-action Goto Github PK

Feature Suggestion

• remove the binary yq from the repository and get it in the run of the action from the original repository

Possible Implementation

• add additional step to the action to download the binary, like:

sudo wget -O /usr/local/bin/yq https://github.com/mikefarah/yq/releases/download/v4.8.0/yq_linux_amd64
sudo chmod +x /usr/local/bin/yq

Context

• easier usage of the action without explicit checkout

Bug Description

• action throws an error if there are no changes to push

Expected Behavior

• no error

How to Reproduce

• retrigger deployment

Possible solution

https://stackoverflow.com/questions/8123674/how-to-git-commit-nothing-without-an-error

Feature Suggestion

At the moment three stages are hard coded and can't configured differently. This includes also the triggers when the stage should be updated. It would be a great option if the stages are configurable and more flexible for other projects with more stages or other names and other triggers.

Possible Implementation

Option 1

• Parameter of the Action (only string can be used)

- name: GitOps (build, push and deploy a new Docker image)
  uses: Staffbase/gitops-github-action@main
  with:
    stages: |
      - name: 'dev'
        trigger: 'refs/heads/dev'
        files: ['kubernetes/namespaces/myService/dev/myService-deploy.yaml']
        path: 'spec.template.spec.containers.backend.image'
    
      - name: stage
        trigger: 'refs/heads/main'
        files: ['kubernetes/namespaces/myService/stage/myService-deploy.yaml']
        path: 'spec.template.spec.containers.backend.image'  
    
      - name: prod
        trigger: 'refs/tags/*'
        files: ['kubernetes/namespaces/myService/prod/myService-deploy.yaml']
        path: 'spec.template.spec.containers.backend.image' 
    # other options

Option 2

• dot file in the repository, e.g .gitops or .github/gitops-github-action.yml

---
stages:
  - name: 'dev'
    trigger: 'refs/heads/dev'
    files: ['kubernetes/namespaces/myService/dev/myService-deploy.yaml']
    path: 'spec.template.spec.containers.backend.image'
  
  - name: stage
    trigger: 'refs/heads/main'
    files: ['kubernetes/namespaces/myService/stage/myService-deploy.yaml']
    path: 'spec.template.spec.containers.backend.image'  
  
  - name: prod
    trigger: 'refs/tags/*'
    files: ['kubernetes/namespaces/myService/prod/myService-deploy.yaml']
    path: 'spec.template.spec.containers.backend.image' 

Context

• Configurable Stages for Deployment

When you disable the docker build/push using dockerenabled: false, you have to provide the action with registry-credentials anyway. This doesn't make sense and in case docker is disabled for the run, the credentials should not be required.

Feature Suggestion

• add an additional step so the docker image is not built again but you can reuse the last tag

Possible Implementation

• add an extra step and retag the last existing image
• mixing existing parameters or create a new option retagging_enabled

Example

An example: Currently we have an extra step in the backend for example.

Feature Suggestion

• there is a new major release for the binary file

Possible Implementation

• first: use the new version + adapt the command calls (migration guide)
• second: using the GitHub action so it is not necessary to download the binary

Feature Suggestion

• remove options gitopsenabled and dockerenabled

Possible Implementation

• check for gitops with gitopstoken
• check for docker with dockeruser and dockerpassword