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.

Sign up for GitHub

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

Jump to bottom

Add instructions for building and testing with Rust #35725

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Add instructions for building and testing with Rust #35725

wants to merge 3 commits into from
+185 −0

Conversation

foursixnine
Copy link

@foursixnine foursixnine commented Dec 19, 2024 •
edited
Loading

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:

  • Update filename
  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. 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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Dec 19, 2024
@foursixnine foursixnine changed the title Oxidizegithub Add instructiuons for building and testing rust Dec 19, 2024
@foursixnine foursixnine changed the title Add instructiuons for building and testing rust Add instructions for building and testing with Rust Dec 20, 2024
@nguyenalex836
Copy link
Contributor

@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 nguyenalex836 added content This issue or pull request belongs to the Docs Content team actions This issue or pull request should be reviewed by the docs actions team waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Dec 20, 2024
@foursixnine
Copy link
Author

@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
Copy link
Contributor

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

@foursixnine foursixnine mentioned this pull request Dec 22, 2024
Open
5 tasks
@foursixnine
Copy link
Author

foursixnine commented Dec 22, 2024 •
edited
Loading

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

@nguyenalex836 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
janbrasna reviewed Dec 27, 2024
View reviewed changes
Copy link
Contributor

@janbrasna janbrasna left a comment

Choose a reason for hiding this comment

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

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
- CI
shortTitle: Build & test Rust
redirect_from:
- /actions/automating-builds-and-tests/building-and-testing-rust
Copy link
Contributor

Choose a reason for hiding this comment

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

Has there been any previous content at this URL to warrant adding a redirect?

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).
Copy link
Contributor

Choose a reason for hiding this comment

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

Is the Go toolchain mention intentional?

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md
Comment on lines +5 to +7
fpt: '*'
ghes: '*'
ghec: '*'
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Author

Choose a reason for hiding this comment

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

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 Show resolved Hide resolved
content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md Show resolved Hide resolved
content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md Show resolved Hide resolved
content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md Show resolved Hide resolved
content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md Show resolved Hide resolved
content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md

## Introduction

This guide shows you how to build, test, and publish a Rust package.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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.

Copy link
Author

Choose a reason for hiding this comment

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

I'll add the instructions for publishing to crates.io, as I don't know if GitHub has one for rust specifically..

foursixnine/cndk8#3

content/actions/use-cases-and-examples/building-and-testing/building-and-testing-rust.md Show resolved Hide resolved
@foursixnine foursixnine marked this pull request as draft December 27, 2024 09:01
@foursixnine
Copy link
Author

foursixnine commented Dec 27, 2024 •
edited
Loading

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 foursixnine mentioned this pull request Dec 30, 2024
Merged
@foursixnine
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@janbrasna janbrasna janbrasna left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Rust: Add instructions for building and testing
3 participants
@foursixnine @nguyenalex836 @janbrasna