Skip to content

Commit

Permalink
Add a note about gitconfig username and email automatic update (#2692)
Browse files Browse the repository at this point in the history
  • Loading branch information
vinokurig authored Mar 25, 2024
1 parent b0aafdb commit defaca6
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions modules/end-user-guide/pages/mounting-git-configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@
[id="mounting-git-configuration"]
= Mounting Git configuration

[NOTE]
====
The `user.name` and `user.email` fields will be set automatically to the `gitconfig` content from a git provider, connected to {prod-short} by a xref:using-a-git-provider-access-token.adoc[Git-provider access token] or a token generated via OAuth, if username and email are set on the provider's user profile page.
====
Follow the instructions below to mount a Git config file in a workspace.

.Prerequisites
Expand All @@ -31,11 +35,11 @@ metadata:
controller.devfile.io/mount-as: subpath
controller.devfile.io/mount-path: /etc/
data:
gitconfig: "[user] \n name = __<git_user_name>__ \n email = __<git_user_email>__" <2>
gitconfig: <gitconfig content> <2>
----
+
<1> A user namespace. Visit `pass:c,a,q[{prod-url}]/api/kubernetes/namespace` to get your {prod-short} user namespace as `name`.
<2> Your Git user name and email.
<2> The content of your gitconfig file content.

. Apply the ConfigMap.
+
Expand Down

0 comments on commit defaca6

Please sign in to comment.