Skip to content

chore: update readme, add version warnings, examples #71

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

ethanndickson
Copy link
Member

@ethanndickson ethanndickson commented Aug 13, 2024

Closes #69.

Copy link
Member Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @ethanndickson and the rest of your teammates on Graphite Graphite

@ethanndickson ethanndickson requested a review from matifali August 13, 2024 05:38
@ethanndickson ethanndickson marked this pull request as ready for review August 13, 2024 05:38
@ethanndickson ethanndickson force-pushed the 08-13-chore_update_readme_add_version_warnings_examples branch from a052493 to e7838de Compare August 13, 2024 05:42
Copy link
Member

@matifali matifali left a comment

Choose a reason for hiding this comment

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

Great work Ethan. a few nits but LGTM.

Comment on lines 23 to 38
resource "coderd_template" "ubuntu-main" {
name = "ubuntu-main"
description = "The main template for developing on Ubuntu."
versions = [
{
name = "stable-${var.TFC_CONFIGURATION_VERSION_GIT_COMMIT_SHA}"
description = "The stable version of the template."
directory = "./stable-template"
},
{
name = "staging-${var.TFC_CONFIGURATION_VERSION_GIT_COMMIT_SHA}"
description = "The staging version of the template."
directory = "./staging-template"
}
]
}
Copy link
Member

Choose a reason for hiding this comment

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

I know that we support multiple versions of a template where one can be set as active. But should we actually recommend customers doing it? How is it more preferred than maintaining two different templates for stable and staging?
I would also like @bpmct and @ammario thoughts on this example.

Copy link
Member Author

@ethanndickson ethanndickson Aug 13, 2024

Choose a reason for hiding this comment

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

We've just been operating on the assumption that the functionality is there, if people want it.
I only include this example as we currently don't have a great way to otherwise communicate that these versions in the list don't represent a single version on the Coder deployment, and rather are a 'branch' of versions. Though maybe that can be reasonably deduced with one item in the list?

Copy link
Member

Choose a reason for hiding this comment

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

I agree that this example is a best demonstration of the full capability of the provider.

@ethanndickson ethanndickson force-pushed the 08-13-chore_update_readme_add_version_warnings_examples branch from e7838de to 9628064 Compare August 13, 2024 06:17
@ethanndickson ethanndickson force-pushed the 08-13-chore_update_readme_add_version_warnings_examples branch from 9628064 to 080352d Compare August 13, 2024 06:49
Copy link
Member Author

ethanndickson commented Aug 13, 2024

Merge activity

@ethanndickson ethanndickson merged commit d23df4c into main Aug 13, 2024
14 checks passed
@ethanndickson ethanndickson deleted the 08-13-chore_update_readme_add_version_warnings_examples branch August 19, 2024 15:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Version compatibility with Coder releases
2 participants