Skip to content

docs(dotfiles): add hint about using SSH URLs when HTTPS cloning is restricted#757

Merged
DevelopmentCats merged 5 commits into
mainfrom
docs/dotfiles-ssh-url-hint
Feb 27, 2026
Merged

docs(dotfiles): add hint about using SSH URLs when HTTPS cloning is restricted#757
DevelopmentCats merged 5 commits into
mainfrom
docs/dotfiles-ssh-url-hint

Conversation

@blinkagent
Copy link
Copy Markdown
Contributor

@blinkagent blinkagent Bot commented Feb 25, 2026

Some Git providers (e.g. on-prem GitLab) disable HTTPS cloning by default, which causes the dotfiles clone to silently fail during workspace startup. Users see "Startup scripts are still running" but the dotfiles folder is never populated.

This PR adds two small documentation touches:

  1. main.tf default description — appends a one-liner suggesting SSH URLs when HTTPS is restricted. This is what users see in the Coder UI parameter prompt.
  2. README.md — new "SSH vs HTTPS URLs" section with an example and a brief explanation of why SSH URLs are more reliable during startup.

No logic changes, no new variables — just documentation.

@bjornrobertsson
Copy link
Copy Markdown

Added as Inbound suggestion from customer using a HTTPS URL, which does not utilize the external auth, and/or can cause a silent failure (i.e. .git folder exists, correct reference, but clone will not work while a git:// would)

Comment thread registry/coder/modules/dotfiles/README.md Outdated
@DevelopmentCats DevelopmentCats added the version:patch Add to PRs requiring a patch version upgrade label Feb 27, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Version Bump Required

One or more modules in this PR need their versions updated.

To fix this:

  1. Run the version bump script locally:
    ./.github/scripts/version-bump.sh patch
  2. Commit the changes:
    git add . && git commit -m "chore: bump module versions (patch)"
  3. Push your changes

The CI will automatically re-run once you push the updated versions.

Copy link
Copy Markdown
Collaborator

@DevelopmentCats DevelopmentCats left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After the update for Atif's comment this looks good to me!

But you will need to update the module version in the README @bjornrobertsson

@DevelopmentCats DevelopmentCats merged commit a0a3783 into main Feb 27, 2026
4 checks passed
@DevelopmentCats DevelopmentCats deleted the docs/dotfiles-ssh-url-hint branch February 27, 2026 20:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

version:patch Add to PRs requiring a patch version upgrade

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants