Update asciinema tutorial to use mage not compile-release-tools

kubernetes-sigs / bom

A utility to generate SPDX-compliant Bill of Materials manifests

https://kubernetes-sigs.github.io/bom/

Apache License 2.0

325 stars 48 forks source link

Update asciinema tutorial to use mage not compile-release-tools #367

Closed pnasrat closed 5 months ago

pnasrat commented 9 months ago

/kind documentation

What happened:

I was checking out bom and the instructions in the asciinema for building the tool are incorrect.

Following https://github.com/kubernetes/release/commit/9d20564edf038ff1df5625de4d6878eb01fb5e96#diff-6b680f315f5f071ad9a14ff82bfcf67880a01f26e03cafbb8bd2553a5c1b6ddd the asciinema tutorial is misleading as it mentions ./compile-release-tools which no longer supports bom

Based upon reading the github workflow config the current way for a local build should be go run mage.go buildBinariesSnapshot

What you expected to happen:

Documentation containing build instructions works

cpanato commented 9 months ago

Thanks, are you willing to open a PR to fix that?

pnasrat commented 9 months ago

@cpanato I can write a PR to add the Documentation on how to build, and then see if I can get a reasonable version of a screencast if that's something the project wants to retain in the README

cpanato commented 8 months ago

i think the screencast we can drop, wdyt @puerco ?

k8s-triage-robot commented 5 months ago

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue as fresh with /remove-lifecycle stale
Close this issue with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale