Skip to content
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

golang: add note about automatic toolchain switching #4318

Conversation

danmilon
Copy link
Contributor

@danmilon danmilon commented Jan 6, 2025

Why

Because in golang, there is a loose coupling between the version specified by the user, and the version that can be used. Essentially it will download any toolchain version automatically.

But users should still be encouraged to keep the selected version updated, in order to have more up to date software.

See also internal ticket: https://linear.app/platformsh/issue/IMG-1785

What's changed

Added a section in both psh and upsun golang docs about this.

What I'm not sure about is how to word the suggestion to keep the golang version in the yaml configuration files up to date.

Where are changes

Updates are for:

  • platform (sites/platform templates)
  • upsun (sites/upsun templates)

@Kemi-Elizabeth Kemi-Elizabeth added the build-fork To build PRs from forks label Jan 6, 2025
@Kemi-Elizabeth
Copy link
Collaborator

@danmilon regarding how to suggest that users should keep their golang version up to date in the yaml. We can use a note block to ensure it catches users attention. Something like:

{{< note >}}

It is important to keep your chosen version of golang updated in your yaml configuration file. This will ensure that you are using the most up to date software for your projects.

{{< /note >}}

Kemi-Elizabeth
Kemi-Elizabeth previously approved these changes Jan 6, 2025
@danmilon danmilon force-pushed the mr/danmilon/golang-add-note-about-go-toolchain-auto-download branch 2 times, most recently from c5cf736 to 36bce69 Compare January 9, 2025 09:09
@danmilon danmilon force-pushed the mr/danmilon/golang-add-note-about-go-toolchain-auto-download branch from 36bce69 to 922c7cd Compare January 9, 2025 09:23
@danmilon
Copy link
Contributor Author

danmilon commented Jan 9, 2025

I don't understand what's wrong with CI.

@danmilon
Copy link
Contributor Author

danmilon commented Jan 9, 2025

sorry about the typo. I see you fixed it already, thank you!

@Kemi-Elizabeth Kemi-Elizabeth merged commit cda8e68 into platformsh:main Jan 9, 2025
15 of 16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build-fork To build PRs from forks markdown/prose
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants