v0.1.0

Manual Approval Gate

Features

• While referring the approvalTask in the pipelinerun following params need to be added

  • approvers - The users who can approve/reject the approvalTask to unblock the pipeline
  • numberOfApprovalsRequired - Numbers of approvals required to unblock the pipeline
  • description - Description of approvalTask which users want to give

• Support for multiple users

  • Until and unless numberOfApprovalsRequired limit is not reached i.e approval task does not get approval from the users as approve, till then approvalState will be pending
  • If any one approver rejects the approval task controller will mark the approvalState as rejected and then the pipelinerun will fail
  • If a user approves for the first time and still approvalsRequired limit is not reached i.e. approvalState is in pending state then user can still change his input and mark the approval task as reject

• A webhook is configured while you install manual-approval-gate which will take care of all the checks which are required while the approver approves/rejects the approvalTask

• Users can add timeout to the approvalTask

• As of today once the timeout exceeds, approvalTask state is marked as rejected and correspondingly customrun and pipelinerun will be failed

• Users can add messages while approving/rejecting the approvalTask

What's Changed

• Create a custom task skeleton by @vdemeester in #1
• Have a 'running' custom task controller by @vdemeester in #3
• approval http service by @vdemeester in #5
• Switch from gorrila/mux to go-chi by @vdemeester in #10
• Bump github.com/tektoncd/pipeline from 0.40.2 to 0.41.0 by @dependabot in #11
• Bump k8s.io/api from 0.25.3 to 0.25.4 by @dependabot in #12
• Bump k8s.io/code-generator from 0.25.2 to 0.25.4 by @dependabot in #14
• Bump k8s.io/client-go from 0.25.3 to 0.25.4 by @dependabot in #13
• Bump github.com/tektoncd/pipeline from 0.41.0 to 0.42.0 by @dependabot in #15
• Bump go.uber.org/zap from 1.23.0 to 1.24.0 by @dependabot in #16
• Bump github.com/go-chi/chi/v5 from 5.0.7 to 5.0.8 by @dependabot in #17
• Bump github.com/tektoncd/pipeline from 0.42.0 to 0.43.0 by @dependabot in #22
• Bump github.com/tektoncd/pipeline from 0.43.0 to 0.43.1 by @dependabot in #23
• Bump github.com/tektoncd/pipeline from 0.43.1 to 0.43.2 by @dependabot in #24
• Bump github.com/tektoncd/pipeline from 0.43.2 to 0.44.0 by @dependabot in #29
• Bump github.com/tektoncd/pipeline from 0.44.0 to 0.45.0 by @dependabot in #30
• Migrate from runs to customruns by @PuneetPunamiya in #55
• Adds implementation and test for API: /approvaltask by @PuneetPunamiya in #56
• Adds OWNERS file by @PuneetPunamiya in #61
• Creates the dynamic client using knative/pkg by @PuneetPunamiya in #58
• Bump actions/setup-go from 3 to 4 by @dependabot in #35
• Bump gomodules.xyz/jsonpatch/v2 from 2.2.0 to 2.4.0 by @dependabot in #66
• Bump github.com/go-chi/chi/v5 from 5.0.8 to 5.0.10 by @dependabot in #67
• Adds implementation and test for API: /approvaltask/{approvalTaskName} by @PuneetPunamiya in #64
• Bump docker/login-action from 2 to 3 by @dependabot in #79
• Bump go.uber.org/zap from 1.24.0 to 1.26.0 by @dependabot in #83
• Bump github.com/stretchr/testify from 1.8.3 to 1.8.4 by @dependabot in #72
• Bumps tektoncd/pipeline to v0.51.0 by @PuneetPunamiya in #78
• Bump actions/checkout from 3 to 4 by @dependabot in #76
• Fixes config files by @PuneetPunamiya in #80
• Bump github.com/tektoncd/pipeline from 0.51.0 to 0.53.0 by @dependabot in #92
• Adds a MVP for Manual Approval Gate hooked with the API service by @PuneetPunamiya in #77
• Refactors the reconciler and adds some unit tests by @PuneetPunamiya in #93
• Bump github.com/tektoncd/pipeline from 0.53.0 to 0.53.2 by @dependabot in #99
• Adds development docs by @PuneetPunamiya in #100
• Handles both string and bool type for the approval field in the update api by @PuneetPunamiya in #101
• Removes API server as we can use existing CRD API's by @PuneetPunamiya in #113
• Bump actions/cache from 3 to 4 by @dependabot in #117
• Adds jkandasa and piyush-garg as OWNERS by @PuneetPunamiya in #134
• Bump actions/setup-go from 4 to 5 by @dependabot in #105
• Adds release script for smoother git releases by @PuneetPunamiya in #103
• Bump github.com/go-chi/chi/v5 from 5.0.10 to 5.0.12 by @dependabot in #123
• Adds support for approvals from multiple users by @PuneetPunamiya in #125
• Add auth using webhook by @PuneetPunamiya in #127
• Adds timeout support for approval task by @PuneetPunamiya in #132
• Add support for messages by @PuneetPunamiya in #128
• Adds a field to add descripiton for approvaltask by @PuneetPunamiya in #143
• Removes pod security policies from roles and clusterroles by @PuneetPunamiya in #145
• Bump github.com/stretchr/testify from 1.8.4 to 1.9.0 by @dependabot in #136
• Bump go.uber.org/zap from 1.26.0 to 1.27.0 by @dependabot in #135
• Bump go version to 1.21 by @piyush-garg in #146
• Bump tektoncd/pipeline to v0.59.0 by @piyush-garg in #148
• Bump github.com/docker/docker from 26.0.0+incompatible to 26.0.2+incompatible by @dependabot in #149
• Updates release script and also adds configmap to add version by @PuneetPunamiya in #147
• Updates development docs by @PuneetPunamiya in #144
• Update Readme.md by @PuneetPunamiya in #150

New Contributors

• @vdemeester made their first contribution in #1
• @piyush-garg made their first contribution in #146

Full Changelog: https://github.com/openshift-pipelines/manual-approval-gate/commits/v0.1.0