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

foursixnine · 2025-02-03T11:00:02Z

@foursixnine - my apologies for the slow review on your contribution. I think that we're waiting on an internal reviewer still. I'll check into this 👀

No worries, was just about to ask (literally now) if there was something else needed :) good to see its mostly waiting for internal review, will keep my eye open

felicitymay · 2025-02-03T11:01:46Z

It seems as if I missed the notification that the internal review was complete, so didn't come back to check the style guide details. I'll make this a priority today and we should be able to get your new article published today 🤞🏻

felicitymay

A few comments in response to @janbrasna, I don't seem to be able to see a preview for this PR, so am going to look more closely locally.

This is likely to be because we've moved to a new preview process since this PR was opened.

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

felicitymay · 2025-02-03T11:53:22Z

The comment with the links to the preview is now hidden by default, but the preview is available here: Building and testing Rust - GitHub Docs

felicitymay

@foursixnine - I've just pushed a commit that aims to address the remainder of @janbrasna's points, and to bring the content into line with our style guide.

When the preview's been rebuilt, it would be great if you could check that I've not added any errors.

I might also have a few more questions, but I think that we're nearly there.

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

felicitymay · 2025-02-03T13:08:22Z

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

+
+The `release` keyword used in this example corresponds to a cargo profile. You can use any [profile](https://doc.rust-lang.org/cargo/reference/profiles.html) you have defined in your `Cargo.toml` file.
+
+## Publishing your package or library to crates.io


I'm assuming that this is the most common use case, so I moved it so that it was before the section on uploading artifacts to GitHub.

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

felicitymay · 2025-02-03T13:10:46Z

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

@@ -38,6 +39,37 @@ We recommend that you have a basic understanding of the Rust language. For more
 1. On the "Rust - by {% data variables.product.prodname_actions %}" workflow, click **Configure**.

   ![Screenshot of the "Choose a workflow" page. The "Configure" button on the "Rust" workflow is highlighted with an orange outline.](/assets/images/help/actions/starter-workflow-rust.png)
+
+{%- ifversion ghes %}


This section is for GitHub Enterprise Server users who may not have access to GitHub Marketplace.

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

janbrasna

Great edits, looks better now!

I'd suggest removing some of the placeholders (that consumers should populate with their own content) that only serve "cosmetic" purposes, to simplify a bit (and put the stress on the important parts, where that is a part of the code actually run):

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

Co-authored-by: Jan Brasna <[email protected]>

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

felicitymay

A couple more minor tweaks.

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

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

…ilding-and-testing-rust.md

felicitymay

@foursixnine - many thanks for your patience with this pull request 💖

@mattr- and @janbrasna - many thanks for your reviews 💖

I'm happy to approve this from the Docs team point of view. We can always make further updates if we think of any improvements.

You should be able to see the preview here: https://os-docs-review.github.com/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust?review-server-repository=foursixnine%2Fdocs&review-server-branch=oxidizegithub. If you don't see the latest changes, go to https://os-docs-review.github.com/refresh and then do a hard refresh of the page.

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

Co-authored-by: Matt Rogers <[email protected]>

felicitymay

Thanks for the extra look @mattr- 🚀

github-actions · 2025-02-03T22:34:06Z

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡

felicitymay · 2025-02-04T08:40:00Z

https://docs.github.com/en/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust is live.

Thanks for your contribution and collaboration on this new article @foursixnine 💖

foursixnine · 2025-02-04T10:32:29Z

Thanks a lot! happy to see the changes live already :D

foursixnine temporarily deployed to preview-env-35725 December 19, 2024 22:58 — with GitHub Actions Inactive

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 temporarily deployed to preview-env-35725 December 20, 2024 10:02 — with GitHub Actions Inactive

nguyenalex836 temporarily deployed to preview-env-35725 December 20, 2024 16:59 — with GitHub Actions Inactive

foursixnine mentioned this pull request Dec 22, 2024

Rust: Add instructions for building and testing #35747

Closed

5 tasks

foursixnine temporarily deployed to preview-env-35725 December 22, 2024 18:21 — with GitHub Actions Inactive

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

Rust: Add instructions for building and testing #35747

Closed

5 tasks

janbrasna reviewed Dec 27, 2024

View reviewed changes

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

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 temporarily deployed to preview-env-35725 December 30, 2024 22:01 — with GitHub Actions Inactive

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

foursixnine temporarily deployed to preview-env-35725 December 30, 2024 22:45 — with GitHub Actions Inactive

felicitymay reopened this Feb 3, 2025

felicitymay removed the stale There is no recent activity on this issue or pull request label Feb 3, 2025

github-actions bot added the triage Do not begin working on this issue until triaged by the team label Feb 3, 2025

Merge branch 'main' into oxidizegithub

9ccd2ed

felicitymay removed the triage Do not begin working on this issue until triaged by the team label Feb 3, 2025

felicitymay reviewed Feb 3, 2025

View reviewed changes

Apply suggestions from code review

2d51aca

Updates for docs styling

e4a060b

felicitymay reviewed Feb 3, 2025

View reviewed changes

janbrasna reviewed Feb 3, 2025

View reviewed changes

Apply suggestions from code review

4b29cd9

Co-authored-by: Jan Brasna <[email protected]>

felicitymay reviewed Feb 3, 2025

View reviewed changes

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

felicitymay reviewed Feb 3, 2025

View reviewed changes

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

assets/images/help/actions/starter-workflow-rust.png Outdated Show resolved Hide resolved

Update content/actions/use-cases-and-examples/building-and-testing/bu…

9c64764

…ilding-and-testing-rust.md

felicitymay previously approved these changes Feb 3, 2025

View reviewed changes

mattr- reviewed Feb 3, 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

felicitymay reviewed Feb 3, 2025

View reviewed changes

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

Apply suggestions from code review

cc551cc

Co-authored-by: Matt Rogers <[email protected]>

felicitymay dismissed their stale review via cc551cc February 3, 2025 18:55

felicitymay approved these changes Feb 3, 2025

View reviewed changes

felicitymay added this pull request to the merge queue Feb 3, 2025

Merged via the queue into github:main with commit f07c33d Feb 3, 2025
47 checks passed

foursixnine deleted the oxidizegithub branch February 4, 2025 08:18

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

foursixnine commented Feb 3, 2025

felicitymay commented Feb 3, 2025

felicitymay left a comment

felicitymay commented Feb 3, 2025

felicitymay left a comment

felicitymay Feb 3, 2025

felicitymay Feb 3, 2025

janbrasna left a comment

felicitymay left a comment

felicitymay left a comment •

edited

Loading

felicitymay left a comment

github-actions bot commented Feb 3, 2025

felicitymay commented Feb 4, 2025

foursixnine commented Feb 4, 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).


		The `release` keyword used in this example corresponds to a cargo profile. You can use any [profile](https://doc.rust-lang.org/cargo/reference/profiles.html) you have defined in your `Cargo.toml` file.

		## Publishing your package or library to crates.io

Add instructions for building and testing with Rust #35725

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

janbrasna Dec 26, 2024

Choose a reason for hiding this comment

janbrasna Dec 26, 2024

Choose a reason for hiding this comment

foursixnine Dec 30, 2024

Choose a reason for hiding this comment

foursixnine commented Dec 27, 2024 • edited Loading

foursixnine commented Dec 30, 2024

foursixnine commented Feb 3, 2025

felicitymay commented Feb 3, 2025

felicitymay left a comment

Choose a reason for hiding this comment

felicitymay commented Feb 3, 2025

felicitymay left a comment

Choose a reason for hiding this comment

felicitymay Feb 3, 2025

Choose a reason for hiding this comment

felicitymay Feb 3, 2025

Choose a reason for hiding this comment

janbrasna left a comment

Choose a reason for hiding this comment

felicitymay left a comment

Choose a reason for hiding this comment

felicitymay left a comment • edited Loading

Choose a reason for hiding this comment

felicitymay left a comment

Choose a reason for hiding this comment

github-actions bot commented Feb 3, 2025

felicitymay commented Feb 4, 2025

foursixnine commented Feb 4, 2025

foursixnine commented Dec 19, 2024 •

edited

Loading

foursixnine commented Dec 22, 2024 •

edited

Loading

foursixnine commented Dec 27, 2024 •

edited

Loading

felicitymay left a comment •

edited

Loading