[feat] Provision user and email credentials to gitconfig

[JPinkney]

Signed-off-by: Josh Pinkney joshpinkney@gmail.com

What does this PR do?

This PR automatically provisions user and email credentials to the gitconfig whenever the label: controller.devfile.io/git-user-credential is true.

If you want to provision git credentials to your gitconfig you can use:

apiVersion: v1
kind: ConfigMap
metadata:
name: sample-user-credentials
namespace: devworkspace-controller
labels:
controller.devfile.io/git-user-credential: "true"
controller.devfile.io/watch-configmap: "true"
data:
name: sampleName
email: sampleName@sampleName.com

What issues does this PR fix or reference?

#694

Is it tested? How?

Tested manually using the above configmap, but also added unit tests

PR Checklist

• E2E tests pass (when PR is ready, comment /test v8-devworkspace-operator-e2e, v8-che-happy-path to trigger)
  • v8-devworkspace-operator-e2e: DevWorkspace e2e test
  • v8-che-happy-path: Happy path for verification integration with Che

[openshift-ci]

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: JPinkney

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [JPinkney]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[JPinkney]

/test v8-devworkspace-operator-e2e

[l0rd]

This is good as first implementation. But rather than a specialized ConfigMap for git config username and email we may want to support a new annotation controller.devfile.io/sub-path for generic ConfigMaps labelled with controller.devfile.io/mount-to-devworkspace: "true".

That would allow to mount a complete gitconfig (not only user name and email) and to mount any file in an existing folder:. For example:

kind: ConfigMapapiVersion: v1metadata:
name: git-config-cmannotations:
controller.devfile.io/mount-path: /etc/gitconfigcontroller.devfile.io/sub-path: gitconfiglabels:
controller.devfile.io/mount-to-devworkspace: "true"data:
gitconfig: | [user] email = jojo@gmail.com name = Jojo [core] editor = vim [alias] ...

[amisevsk]

But rather than a specialized ConfigMap for git config username and email we may want to support a new annotation controller.devfile.io/sub-path for generic ConfigMaps labelled with controller.devfile.io/mount-to-devworkspace: "true".

I beat you to the punch by about an hour :D #710

[l0rd]

I beat you to the punch by about an hour :D #710

I saw that earlier today! I was probably still thinking at the right way to inject a gitconfig when you submitted that PR. And you addressed the problem in a simpler way too. That's magic 🧙 🪄 Unfortunately I noticed it too late and I've lost one hour yesterday 😄

[openshift-ci]

@JPinkney: PR needs rebase.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[ibuziuk]

@amisevsk I believe we can close this one, right?

[amisevsk]

I think so, I'll leave the branch in place in case it's needed later as this was initially requested by the Che server IIRC.