Add instructions for building and testing with Rust #35725

foursixnine · 2024-12-19T22:58:27Z

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:

Update filename
A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR.
Review by SME from Github - In most cases, the author can be the SME. Open source contributions may require a SME review from GitHub staff.
The changes in this PR meet the docs fundamentals that are required for all content.
All CI checks are passing.

nguyenalex836 · 2024-12-20T17:03:39Z

@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!

foursixnine · 2024-12-20T18:23:34Z

@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

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!

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!

awesome! I might need guidance, as I'm only looking at only gh community

nguyenalex836 · 2024-12-20T18:31:03Z

@foursixnine Ah gotcha, thank you! ✨ Well I hope you get to have a restful and wonderful weekend 💛

foursixnine · 2024-12-22T18:22:27Z

@foursixnine Ah gotcha, thank you! ✨ Well I hope you get to have a restful and wonderful weekend 💛

@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.

janbrasna

It's referred as WIP/PoC in a few places (although not marked as "Draft" so it appears as ready for review…) therefore this may be preliminary, but to make sure it's tracked in case:

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md

janbrasna · 2024-12-26T15:34:24Z

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md

+
+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).


Is the Go toolchain mention intentional?

janbrasna · 2024-12-26T15:43:00Z

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md

+  fpt: '*'
+  ghes: '*'
+  ghec: '*'


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.

what would be the correct options then? I don't know ftp, ghes or ghec... what would you suggest?

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md

foursixnine · 2024-12-27T09:03:13Z

It's referred as WIP/PoC in a few places (although not marked as "Draft" so it appears as ready for review…) therefore this may be preliminary, but to make sure it's tracked in case:

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.

foursixnine · 2024-12-30T10:05:03Z

Ok, https://crates.io/crates/cndk8/0.1.0 has been published using only github, now docfest starts :D https://github.com/foursixnine/cndk8/actions/runs/12544879009/job/34978215202

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md

github-actions · 2025-01-02T13:47:59Z

Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert 👀

foursixnine · 2025-01-02T18:48:06Z

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md

+      - name: Publish hello app to GitHub Packages
+        run: |
+          curl -u "${{ github.actor }}:${{ secrets.GH_TOKEN }}" \
+            -X POST "https://uploads.github.com/repos/${{ github.repository }}/releases/assets?name=cndk8-hello.tar.gz" \
+            --header "Content-Type: application/gzip" \
+            --data-binary @./cndk8-hello/cndk8


I wonder if this is wanted/desired or if gh has plans to offer a rust registry

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md

…ng/building-and-testing-rust.md Co-authored-by: Matt Rogers <[email protected]>

…ing-and-testing/building-and-testing-rust.md Co-authored-by: Matt Rogers <[email protected]>

foursixnine · 2025-01-16T15:58:41Z

@mattr- Just requested re-review, let me know if anything else is needed, and if I should do squash of some of the commits TIA!

mattr-

Thanks for making those updates! I found one other thing that I noticed the first read through but failed to write a comment on. Other than that one thing, this is ready to go.

mattr- · 2025-01-16T20:26:19Z

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md

+        run: |
+          curl -u "${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}" \
+            -X POST "https://uploads.github.com/repos/${{ github.repository }}/releases/assets?name=cndk8-hello.tar.gz" \
+            --header "Content-Type: application/gzip" \
+            --data-binary @./cndk8-hello/cndk8


I missed commenting on this the first time through. I haven't been able to find documentation about uploads.github.com anywhere other than some stuff for GitHub Connect, which I don't think would be applicable for this guide. What do you think about switching this to use something like gh release upload instead?

What do you think about switching this to use something like gh release upload instead?

@mattr- I feel we could remove this all together; adding a step that does gh release upload, goes more into the question I had already in this comment of whether there would/could be a github registry for rust packages or if this is needed at all, in the context of the guide...

it was actually easier than I thought: https://github.com/foursixnine/hetzner-robot-rs/releases/tag/v0.1.0 was published using the new steps described in this guide: https://github.com/foursixnine/hetzner-robot-rs/actions/runs/12828374178/job/35772361174#step:4:4

foursixnine · 2025-01-17T12:33:29Z

I found one other thing that I noticed the first read through but failed to write a comment on.

Just addressed it, ended up being easier than I thought :D

Other than that one thing, this is ready to go.

🚀🚀🚀 happy to read that, lmk if anything else is needed.

janbrasna

Thinking out loud: (mostly notes for staff/reviewer to consider if applicable…)

janbrasna · 2025-01-18T01:17:07Z

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md

+          path: ./cndk8-hello
+      - name: Publish hello app binary as a release on GitHub
+      - run: |
+          gh release create v0.1.0 --generate-notes


the hard-coded tag doesn't make a good example as folks would trip over this when used in a real workflow — gh release can use some sensible defaults of adding artifacts to the most recent release IIRC?

(TBH I'd avoid creating the release in CI at all; and instead publish the artifacts on release trigger — attaching the assets to the recent/created release instead?)

janbrasna · 2025-01-18T01:17:26Z

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md

+      - name: Publish hello app binary as a release on GitHub
+      - run: |
+          gh release create v0.1.0 --generate-notes
+          gh release upload v0.1.0 ./cndk8-hello/cndk8#my-cndk8-hello-app


the paths seem too specific? (probably taken from a real project, should use some simplifying for demonstration here)

janbrasna · 2025-01-18T01:17:47Z

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md

+          name: cndk8-hello
+          path: ./cndk8-hello


This doesn't make it obvious why this folder structure and naming, would something like hello-app or an obvious placeholder be a better example?

janbrasna · 2025-01-18T01:18:30Z

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md

+        run: cargo publish # publishes your crate as a library that can be added as a dependency
+```
+
+As an example of how packages are published, see the [cndk8 0.1.0](https://crates.io/crates/cndk8/0.1.0). In the case that there are errors with Metadata check


not sure if linking to a non-example crate on an external site is sustainable to maintain from docs; don't see the utility of the reference.

(this all seems taken from a real-world workflow of a real-world project — following the other CI tutorials it would feel better as an "anonymized" hello world type of code and naming?

e.g. in the case of .NET that needs an argument with some placeholder filled in, it uses the GH Docs convention of using angle brackets:

run: dotnet pack --configuration Release <my project>

The examples here should too make it obvious what are just placeholder values in need of filling in correctly before the examples start to work for the reader…

janbrasna · 2025-01-18T01:19:31Z

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md

+          path: target/${{ matrix.BUILD_TARGET }}/cndk8
+```
+
+And to use them on a different job, i.e publishing as a github release, check [AUTOTITLE](/actions/security-for-github-actions/security-guides/automatic-token-authentication) to ensure your workflows have the right permissions on the repository.


"GitHub Release" is the correct case — product names should come from a variable(?)

janbrasna · 2025-01-18T01:26:34Z

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md

+1. Edit the workflow as required. For example, change the version of Rust.
+1. Click **Commit changes**.
+
+{% ifversion fpt or ghec %}


TODO: check for versions applicability.

janbrasna · 2025-01-18T01:26:51Z

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md

+title: Building and testing Rust
+intro: You can create a continuous integration (CI) workflow to build and test your Rust project.
+versions:
+  ghec: '*'


TODO: check for versions applicability.

This is also the reason you don't "see" it in the overview page — cuz the default would be fpt, and since you don't spec that, you can only see it if you switch the overview to ghec — otherwise it won't get listed there.

janbrasna · 2025-01-18T01:27:33Z

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md

+  - CI
+shortTitle: Build, test & Publish with Rust
+---
+<!-- {% data reusables.actions.enterprise-github-hosted-runners %}-->


TODO: check for versions applicability.

And either include the reusable if relevant; or don't if not needed anymore.

janbrasna · 2025-01-18T01:28:51Z

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md

+type: tutorial
+topics:
+  - CI
+shortTitle: Build, test & Publish with Rust


There are three places, title, intro, shortTitle, that either mention publishing, or don't. Consistency?

NB: Correct sentence case?

janbrasna · 2025-01-18T01:31:59Z

assets/images/help/actions/starter-workflow-rust.png

TODO: There's a style guide for UI highlights — does the orange rectangle follow the guidelines for consistency?

TODO: Size/dimensions of the image, is it expected to follow some resolution pattern from other pages for legibility?

foursixnine had a problem deploying to preview-env-35725 December 19, 2024 22:58 — with GitHub Actions Failure

github-actions bot added the triage Do not begin working on this issue until triaged by the team label Dec 19, 2024

foursixnine changed the title ~~Oxidizegithub~~ Add instructiuons for building and testing rust Dec 19, 2024

foursixnine changed the title ~~Add instructiuons for building and testing rust~~ Add instructions for building and testing with Rust Dec 20, 2024

foursixnine had a problem deploying to preview-env-35725 December 20, 2024 10:02 — with GitHub Actions Failure

nguyenalex836 had a problem deploying to preview-env-35725 December 20, 2024 16:59 — with GitHub Actions Failure

foursixnine mentioned this pull request Dec 22, 2024

Rust: Add instructions for building and testing #35747

Open

5 tasks

foursixnine had a problem deploying to preview-env-35725 December 22, 2024 18:21 — with GitHub Actions Failure

nguyenalex836 linked an issue Dec 23, 2024 that may be closed by this pull request

Rust: Add instructions for building and testing #35747

Open

5 tasks

janbrasna reviewed Dec 27, 2024

View reviewed changes

foursixnine marked this pull request as draft December 27, 2024 09:01

foursixnine mentioned this pull request Dec 30, 2024

Add publishing to crates.io foursixnine/cndk8#3

Merged

foursixnine added 3 commits December 30, 2024 23:00

add rust to index

ad14f9e

Add docs for setup

33c9698

Add starter workflow image for rust

7a2354f

foursixnine force-pushed the oxidizegithub branch from a50239a to 7a2354f Compare December 30, 2024 22:01

foursixnine had a problem deploying to preview-env-35725 December 30, 2024 22:01 — with GitHub Actions Failure

foursixnine added 3 commits December 30, 2024 23:31

Remove go leftovers

7eeac62

Add outline to the workflow starter-workflow-rust.png

9d3f658

Update instructions for building, testing and publishing with Rust

f3999cd

Fix liquid linting errors

f608e8b

foursixnine force-pushed the oxidizegithub branch from 115b616 to f608e8b Compare January 2, 2025 12:39

foursixnine temporarily deployed to preview-env-35725 January 2, 2025 12:39 — with GitHub Actions Inactive

felicitymay reviewed Jan 2, 2025

View reviewed changes

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md Outdated Show resolved Hide resolved

felicitymay added the needs SME This proposal needs review from a subject matter expert label Jan 2, 2025

foursixnine commented Jan 2, 2025

View reviewed changes

Fix formatting error in rust guide

f4edaa2

foursixnine temporarily deployed to preview-env-35725 January 3, 2025 09:21 — with GitHub Actions Inactive

foursixnine requested a review from felicitymay January 3, 2025 12:03

mattr- reviewed Jan 16, 2025

View reviewed changes

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md Outdated Show resolved Hide resolved

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md Outdated Show resolved Hide resolved

Fix typo in content/actions/use-cases-and-examples/building-and-testi…

d6ea9d5

…ng/building-and-testing-rust.md Co-authored-by: Matt Rogers <[email protected]>

foursixnine had a problem deploying to preview-env-35725 January 16, 2025 15:50 — with GitHub Actions Error

Make token name explicit content/actions/use-cases-and-examples/build…

69120e8

…ing-and-testing/building-and-testing-rust.md Co-authored-by: Matt Rogers <[email protected]>

foursixnine had a problem deploying to preview-env-35725 January 16, 2025 15:52 — with GitHub Actions Failure

foursixnine requested a review from mattr- January 16, 2025 15:55

Merge branch 'main' into oxidizegithub

8ae6c71

foursixnine temporarily deployed to preview-env-35725 January 16, 2025 15:56 — with GitHub Actions Inactive

nguyenalex836 added SME reviewed An SME has reviewed this issue/PR and removed waiting for review Issue/PR is waiting for a writer's review needs SME This proposal needs review from a subject matter expert labels Jan 16, 2025

mattr- reviewed Jan 16, 2025

View reviewed changes

foursixnine temporarily deployed to preview-env-35725 January 17, 2025 12:13 — with GitHub Actions Inactive

foursixnine requested a review from mattr- January 17, 2025 12:18

Explain how to publish using GitHub CLI

6150931

foursixnine force-pushed the oxidizegithub branch from 7864e26 to 6150931 Compare January 17, 2025 12:21

foursixnine deployed to preview-env-35725 January 17, 2025 12:21 — with GitHub Actions View deployment

janbrasna reviewed Jan 18, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add instructions for building and testing with Rust #35725

Add instructions for building and testing with Rust #35725

foursixnine commented Dec 19, 2024 •

edited

Loading

nguyenalex836 commented Dec 20, 2024

foursixnine commented Dec 20, 2024

nguyenalex836 commented Dec 20, 2024

foursixnine commented Dec 22, 2024 •

edited

Loading

janbrasna left a comment

janbrasna Dec 26, 2024

janbrasna Dec 26, 2024

foursixnine Dec 30, 2024

foursixnine commented Dec 27, 2024 •

edited

Loading

foursixnine commented Dec 30, 2024

github-actions bot commented Jan 2, 2025

foursixnine Jan 2, 2025

foursixnine commented Jan 16, 2025

mattr- left a comment

mattr- Jan 16, 2025

foursixnine Jan 16, 2025 •

edited

Loading

foursixnine Jan 17, 2025

foursixnine commented Jan 17, 2025

janbrasna left a comment

janbrasna Jan 18, 2025

janbrasna Jan 18, 2025

janbrasna Jan 18, 2025

janbrasna Jan 18, 2025

janbrasna Jan 18, 2025

janbrasna Jan 18, 2025

janbrasna Jan 18, 2025

janbrasna Jan 18, 2025

janbrasna Jan 18, 2025

janbrasna Jan 18, 2025

janbrasna Jan 18, 2025

janbrasna Jan 18, 2025

janbrasna Jan 18, 2025


		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).

Add instructions for building and testing with Rust #35725

Are you sure you want to change the base?

Add instructions for building and testing with Rust #35725

Conversation

foursixnine commented Dec 19, 2024 • edited Loading

Why:

What's being changed (if available, include any code snippets, screenshots, or gifs):

Check off the following:

nguyenalex836 commented Dec 20, 2024

foursixnine commented Dec 20, 2024

nguyenalex836 commented Dec 20, 2024

foursixnine commented Dec 22, 2024 • edited Loading

janbrasna left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

foursixnine commented Dec 27, 2024 • edited Loading

foursixnine commented Dec 30, 2024

github-actions bot commented Jan 2, 2025

Choose a reason for hiding this comment

foursixnine commented Jan 16, 2025

mattr- left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

foursixnine Jan 16, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

foursixnine commented Jan 17, 2025

janbrasna left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

foursixnine commented Dec 19, 2024 •

edited

Loading

foursixnine commented Dec 22, 2024 •

edited

Loading

foursixnine commented Dec 27, 2024 •

edited

Loading

foursixnine Jan 16, 2025 •

edited

Loading