eclipse-che / che

Kubernetes based Cloud Development Environments for Enterprise Teams
http://eclipse.org/che
Eclipse Public License 2.0
6.99k stars 1.19k forks source link

Document which GH, GitLab and Bitbucket flavors support OAuth and PAT #21936

Open l0rd opened 1 year ago

l0rd commented 1 year ago

Is your enhancement related to a problem? Please describe

In documentation we mention that we support GitHub, GitLab and Bitbucket OAuth flow and PAT.

But we do not specify the details about flavors that are supported:

Describe the solution you'd like

  1. Provide a support matrix:
OAuth App support PAT support
GitHub github.com
GitHub Enterprise Cloud
GitHub Enterprise Server
GitLab SaaS
GitLab Server
Bitbucket Cloud
Bitbucket Server
  1. Explain the behavior when OAuth / PAT are supported / configured and when their are not
GH/BB/GitLab configured GH/BB/GitLab NOT configured Other Git services (e.g. sourcehut, gerrit, gogs, gitea,gitolite etc...) with git credentials configured Other Git services (e.g. sourcehut, gerrit, gogs, gitea,gitolite etc...) with git credentials NOT configured
devfile is retrieved at workspace startup ✅ public repo
✅ private repo
✅ public repo
❌ private repo
❌ public repo [1]
❌ private repo
❌ public repo [1]
❌ private repo
git clone succeeds at workspace startup ✅ public repo
✅ private repo
✅ public repo
❌ private repo
✅ public repo
✅ private repo
✅ public repo
❌ private repo
git push succeeds with no configuration ✅ public repo
✅ private repo
❌ public repo
❌ private repo
✅ public repo
✅ private repo
❌ public repo
❌ private repo

[1] in this case the devfile can still be used if the remote URL parameter is used: <che-host>/#<devfile-raw-url>?remotes={<git-repo-url>} (see this issue comment)

l0rd commented 1 year ago

@vinokurig please review/fill the matrix

dmytro-ndp commented 1 year ago

@vinokurig, @l0rd : GitHub github.com with PAT had been successfully tested with DS 3.3.0.

Can https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/ be used to test PAT with bitbucket.org ?

vinokurig commented 1 year ago

Thanks @dmytro-ndp You are right, fixed the matrix table.

l0rd commented 1 year ago

Can support.atlassian.com/bitbucket-cloud/docs/app-passwords be used to test PAT with bitbucket.org ?

I don't know. But @vinokurig has put a green check for Bitbucket Cloud PAT support in the matrix table.

che-bot commented 1 year ago

Issues go stale after 180 days of inactivity. lifecycle/stale issues rot after an additional 7 days of inactivity and eventually close.

Mark the issue as fresh with /remove-lifecycle stale in a new comment.

If this issue is safe to close now please do so.

Moderators: Add lifecycle/frozen label to avoid stale mode.

ibuziuk commented 1 year ago

@vinokurig @dmytro-ndp folks, what should we do with this issue? is anything else needed or we have everything documented at this point?

dmytro-ndp commented 1 year ago

@ibuziuk: it depends on the goal of the issue. It would better to ask @l0rd if he has satisfied with updated support matrix.

l0rd commented 1 year ago

In docs I still don't see a support matrix. I have opened other issue with other details that are missing (other than the matrix) here.

ibuziuk commented 1 year ago

thanks, https://github.com/eclipse/che/issues/22356 has been resolved, should we also add the support matrix to the docs?

ibuziuk commented 1 year ago

lifecycle/frozen