NotificationsYou must be signed in to change notification settings
Fork921
Star10.1k

chore: unify template naming#15757

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

matifali merged 6 commits intomainfromphorcys/unify-template-naming

Dec 5, 2024

Merged

chore: unify template naming#15757

matifali merged 6 commits intomainfromphorcys/unify-template-naming

Dec 5, 2024

Conversation

Copy link

Member

phorcys420 commentedDec 4, 2024•
edited
Loading

This PR changes template names and docs to follow the<provider>-<os/whatever> format for all templates.
I've decided not to split this into multiple PRs because I'd have to edit rebase the other PRs once one of them gets merged, this should be relatively low-impact anyways.

This aligns with our goals to make templates more user-friendly.

Closes#15754

phorcys420 added4 commits

December 4, 2024 22:48

chore: renamedevcontainer-docker template todocker-devcontainer

38aeaa5

chore: renamedevcontainer-kubernetes template to `kubernetes-devco…

ebf63e7

…ntainer`

chore: renameenvbox template tokubernetes-envbox

da67150

chore: renamedo-linux template todigitalocean-linux

68429e5

github-actionsbot assignedphorcys420

Dec 4, 2024

phorcys420 requested review frombpmct,johnstcn,EdwardAngert andmatifali

December 4, 2024 23:04

github-actionsbot reviewed

Dec 4, 2024

View reviewed changes

docs/admin/templates/managing-templates/devcontainers/add-devcontainer.mdShow resolvedHide resolved

docs/admin/templates/extending-templates/docker-in-workspaces.mdShow resolvedHide resolved

phorcys420 changed the title~~phorcys/unify template naming~~chore: unify template naming

Dec 4, 2024

phorcys420enabled auto-merge (squash)

December 4, 2024 23:06

phorcys420 marked this pull request as draft

December 4, 2024 23:17

auto-merge was automatically disabled

December 4, 2024 23:17

Pull request was converted to draft

Copy link

MemberAuthor

phorcys420 commentedDec 4, 2024

I don't know why all these checks are failing, I'll take a look tomorrow.

Copy link

Member

matifali commentedDec 5, 2024

You need to runmake gen too.
Alsomake fmt for any possible formatting issues.

matifali approved these changes

Dec 5, 2024

View reviewed changes

Copy link

Member

matifali left a comment

Choose a reason for hiding this comment

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

LGTM.
It could be a breaking change if someone is initializing templates in CI.

@bpmct fir visibility.

chore: runmake gen andmake fmt

a736823

matifali requested a review fromhugodutka

December 5, 2024 09:15

Copy link

Member

matifali commentedDec 5, 2024

@phorcys420 you may also need to runmake update-golden-files as we use the template ids for some CLI tests.
See:https://github.com/coder/coder/actions/runs/12176090929/job/33961115484?pr=15757#step:7:579

hugodutka reviewed

Dec 5, 2024

View reviewed changes

Copy link

Contributor

hugodutka left a comment•
edited
Loading

Choose a reason for hiding this comment

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

We've started tracking usage of template examples in telemetry with the current coder release. The PR was merged last week:#15671. We use the example IDs to identify the templates in telemetry, so changing them will confuse the statistics. It's fine if we change the IDs now, but they should remain static in the future.@phorcys420, could you add the following comment inexamples/examples.go above the//go:embed directives?

Template paths should not change over time. They are used as persistent identifiers in telemetry.

Copy link

MemberAuthor

phorcys420 commentedDec 5, 2024

@hugodutka thanks for pointing this out!
I guess we have good timing then! I wanted to do this to set a standard naming convention to avoid confusing our users so I think it will also help you if the names are standardized.