Add instructions for building and testing with Rust #35725
Conversation
foursixnine
had a problem deploying
to
preview-env-35725
GitHub Actions
Failure
github-actions
bot
added
the
triage
foursixnine
changed the title
foursixnine
changed the title
foursixnine
had a problem deploying
to
preview-env-35725
GitHub Actions
Failure
|
@foursixnine Thanks so much for opening a PR! I'll get this triaged for review ✨Just a quick tip - we'd recommend opening an issue before raising a PR, especially for larger scale changes such as this one 💛 This will let our team determine how best to proceed with the concern / issue you are raising, thank you! |
nguyenalex836
added
content
absolutely! I'm behind on creating the issue, was getting: https://github.com/foursixnine/cndk8/actions/runs/12436473960 in shape before, so I'll get back to creating the issue over the weekend :) to not lose momentum!
awesome! I might need guidance, as I'm only looking at only gh community |
|
@foursixnine Ah gotcha, thank you! ✨ Well I hope you get to have a restful and wonderful weekend 💛 |
foursixnine
had a problem deploying
to
preview-env-35725
GitHub Actions
Failure
@nguyenalex836 : A lot of rest is being achieved :D - created #35747 as the issue for this and following Pull requests (if any) related to this. |
| - CI | ||
| shortTitle: Build & test Rust | ||
| redirect_from: | ||
| - /actions/automating-builds-and-tests/building-and-testing-rust |
There was a problem hiding this comment.
Has there been any previous content at this URL to warrant adding a redirect?
|
|
||
| This guide shows you how to build, test, and publish a Rust package. | ||
|
|
||
| {% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with preinstalled software, which includes the dependencies for Go. For a full list of up-to-date software and the preinstalled versions of Go, see [AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners#preinstalled-software). |
There was a problem hiding this comment.
Is the Go toolchain mention intentional?
| fpt: '*' | ||
| ghes: '*' | ||
| ghec: '*' |
There was a problem hiding this comment.
FYI the tracking issue mentions:
"… so It can be reused further by at least community GH (i.e no self hosted runners for now or enterprise features)"
I'm not sure there would be any difference if provisioning the same runners, just felt it's worth noting it's applied to all versions here, while the PR is actually marked as a PoC mentioning only being verified for dotcom and standard runners.
| ```yaml copy | ||
| name: Go | ||
| on: [push] | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - uses: {% data reusables.actions.action-checkout %} | ||
| - name: Setup Go | ||
| uses: {% data reusables.actions.action-setup-rust %} | ||
| with: | ||
| rust-version: '1.8.x' | ||
| - name: Install dependencies | ||
| run: go get . | ||
| - name: Build | ||
| run: go build -v ./... | ||
| - name: Test with the Go CLI | ||
| run: go test |
There was a problem hiding this comment.
This all looks like Go, not Rust.
| steps: | ||
| - uses: {% data reusables.actions.action-checkout %} | ||
| - name: Setup Go | ||
| uses: {% data reusables.actions.action-setup-rust %} |
There was a problem hiding this comment.
action-setup-rust reusable does not exist in this repo.
| ### Using a specific Go version | ||
|
|
||
| You can configure your job to use a specific version of Go, such as `1.20.8`. Alternatively, you can use semantic version syntax to get the latest minor release. This example uses the latest patch release of Go 1.21: | ||
|
|
||
| ```yaml copy | ||
| - name: Setup Go 1.21.x | ||
| uses: {% data reusables.actions.action-setup-go %} | ||
| with: | ||
| # Semantic version range syntax or exact version of Go | ||
| go-version: '1.21.x' | ||
| ``` | ||
|
|
||
| ## Installing dependencies | ||
|
|
||
| You can use `go get` to install dependencies: | ||
|
|
||
| ```yaml copy | ||
| steps: | ||
| - uses: {% data reusables.actions.action-checkout %} | ||
| - name: Setup Go | ||
| uses: {% data reusables.actions.action-setup-go %} | ||
| with: | ||
| go-version: '1.21.x' | ||
| - name: Install dependencies | ||
| run: | | ||
| go get . | ||
| go get example.com/octo-examplemodule | ||
| go get example.com/[email protected] | ||
| ``` | ||
|
|
||
| ### Caching dependencies | ||
|
|
||
| You can cache and restore dependencies using the [`setup-go` action](https://github.com/actions/setup-go). By default, caching is {% ifversion actions-setup-go-default-cache-enabled %}enabled when using the `setup-go` action.{% else %}disabled, but you can set the `cache` parameter to `true` to enable it.{% endif %} | ||
|
|
||
| {% ifversion actions-setup-go-default-cache-enabled %} | ||
| The `setup-go` action searches for the dependency file, `go.sum`, in the repository root and uses the hash of the dependency file as a part of the cache key. | ||
|
|
||
| You can use the `cache-dependency-path` parameter for cases when multiple dependency files are used, or when they are located in different subdirectories. | ||
|
|
||
| ```yaml copy | ||
| - name: Setup Go | ||
| uses: {% data reusables.actions.action-setup-go %} | ||
| with: | ||
| go-version: '1.17' | ||
| cache-dependency-path: subdir/go.sum | ||
| ``` | ||
|
|
||
| {% else %} | ||
|
|
||
| When caching is enabled, the `setup-go` action searches for the dependency file, `go.sum`, in the repository root and uses the hash of the dependency file as a part of the cache key. | ||
|
|
||
| ```yaml copy | ||
| - name: Setup Go | ||
| uses: {% data reusables.actions.action-setup-go %} | ||
| with: | ||
| go-version: '1.21.x' | ||
| cache: true | ||
| ``` | ||
|
|
||
| Alternatively, you can use the `cache-dependency-path` parameter for cases when multiple dependency files are used, or when they are located in different subdirectories. | ||
|
|
||
| ```yaml copy | ||
| - uses: {% data reusables.actions.action-setup-go %} | ||
| with: | ||
| go-version: '1.17' | ||
| cache: true | ||
| cache-dependency-path: subdir/go.sum | ||
| ``` | ||
|
|
||
| {% endif %} |
There was a problem hiding this comment.
Don't see how this Go content is relevant here.
| ## Using a Rust workflow template | ||
|
|
||
| {% data reusables.actions.workflow-templates-get-started %} | ||
|
|
||
| {% data variables.product.prodname_dotcom %} provides a Rust workflow template that should work for most basic Rust projects. The subsequent sections of this guide give examples of how you can customize this workflow template. |
There was a problem hiding this comment.
I believe the template referenced is the starter workflow here: https://github.com/actions/starter-workflows/blob/main/ci/rust.yml — so the following code examples should probably base off of that workflow?
| @@ -0,0 +1,184 @@ | |||
| [--- | |||
There was a problem hiding this comment.
This is not a valid front matter here, so it won't even build now.
|
|
||
| ## Introduction | ||
|
|
||
| This guide shows you how to build, test, and publish a Rust package. |
There was a problem hiding this comment.
| This guide shows you how to build, test, and publish a Rust package. | |
| This guide shows you how to build and test a Rust package. |
Doesn't show how to publish, currently.
| 1. Filter the selection of workflows by clicking **Continuous integration**. | ||
| 1. On the "Rust - by {% data variables.product.prodname_actions %}" workflow, click **Configure**. | ||
|
|
||
|  |
There was a problem hiding this comment.
This shows a screen shot of a Go starter workflow, not Rust.
Thanks for the review, marked as draft for now - will re-request reviews once final draft ins ready (I started with a copy of the golang one, so that's why go is all over the place :P; that said thanks for the review, some questions I had you're already pointing out missing pieces. |
Right now, it's a manual search and replace, I would like to build the docs as I find myself the answers to enable my own rust workflows beyond what https://github.com/foursixnine/cndk8/blob/main/.github/workflows/rust.yml is already doing.
was initially: #35721 but panik.
PoC: Add documentation for rust workflows
Why:
Because there's no documentation on how to properly handle rust stuff on github
would take a look later at github/docs/issues/23181 and see what else fails
What's being changed (if available, include any code snippets, screenshots, or gifs):
So far adding documentation based off the Golang one, and my own journey through https://github.com/foursixnine/cndk8/ and isototest-ng
Commits, PR's will be listed
Check off the following:
Still WIP: