doc: edit README.md for reproducible choice interactive change #265

dj8yfo · 2024-12-10T16:36:20Z

No description provided.

dj8yfo · 2024-12-10T16:38:36Z

cargo-near/src/commands/new/mod.rs

@@ -210,7 +210,7 @@ const NEW_PROJECT_FILES: &[NewProjectFile] = &[
    },
    NewProjectFile {
        file_path: "Cargo.toml",
-        content: include_str!("new-project-template/Cargo.toml.template"),


rename helps with syntax highlighting on github:
https://github.com/near/cargo-near/blob/doc-reproducible-interactive/cargo-near/src/commands/new/new-project-template/Cargo.template.toml vs https://github.com/near/cargo-near/blob/main/cargo-near/src/commands/new/new-project-template/Cargo.toml.template

…ax highlighting in gh

dj8yfo · 2024-12-10T18:28:48Z

README.md

+<details>
+  <summary>Additional (optional) details on possible <code>[package.metadata.near.reproducible_build]</code> configuration</summary><p>
+
+1. available images can be found by this link https://hub.docker.com/r/sourcescan/cargo-near/tags 
+  - [`image`](https://github.com/near/cargo-near/blob/main/cargo-near/src/commands/new/new-project-template/Cargo.template.toml#L18) and [`image_digest`](https://github.com/near/cargo-near/blob/main/cargo-near/src/commands/new/new-project-template/Cargo.template.toml#L19) are straightforward to configure:
+  ![image_and_digest_pinpoint](./docs/image_and_digest_pinpoint.png)
+2. build command flags can be configured, if needed, by changing [`container_build_command`](https://github.com/near/cargo-near/blob/main/cargo-near/src/commands/new/new-project-template/Cargo.template.toml#L29) field
+  - base `container_build_command` for images prior to **sourcescan/cargo-near:0.13.0-rust-1.83.0** is `["cargo", "near", "build"]` 
+  - base `container_build_command` for images starting with **sourcescan/cargo-near:0.13.0-rust-1.83.0** and after it  is `["cargo", "near", "build", "non-reproducible-wasm", "--locked"]`, where the `--locked` flag is required
+  - additional flags, if needed, can be looked up on
+    - `cargo near build non-reproducible-wasm --help` for newer/latest images 
+    - `cargo near build --help` for older ones 
+    - running `docker run -it sourcescan/cargo-near:0.11.0-rust-1.82.0` (or another specific image) and checking the `--help` message of exact `cargo-near` in container may be helpful when in doubt    
+3. `cargo near` allows parameterizing build with values of environment variables, present at the time of the build and not present in a contract's source code,
+   by specifying their names in [`passed_env`](https://github.com/near/cargo-near/blob/main/cargo-near/src/commands/new/new-project-template/Cargo.template.toml#L24) array
+  - supported by `sourcescan/cargo-near:0.10.1-rust-1.82.0` image or later images
+  - SourceScan/Nearblocks does not support verifying such contracts yet. 
+
+</p></details>


this is an openable section

dj8yfo · 2024-12-10T18:34:47Z

README.md


 1. runs against source code version, committed to git, ignoring any uncommitted changes
 2. requires that `Cargo.lock` of project is created (e.g. via `cargo update`) and added to git. 
    - this enables `--locked` build by downstream `cargo` command. 
-3. will use configuration in [`[package.metadata.near.reproducible_build]`](https://github.com/near/cargo-near/blob/main/cargo-near/src/commands/new/new-project-template/Cargo.toml.template#L14-L25) 
-   section of contract's `Cargo.toml` and [`package.repository`](https://github.com/near/cargo-near/blob/main/cargo-near/src/commands/new/new-project-template/Cargo.toml.template#L9) field
+3. will use configuration in [`[package.metadata.near.reproducible_build]`](https://github.com/near/cargo-near/blob/main/cargo-near/src/commands/new/new-project-template/Cargo.template.toml#L14-L25) 


due to rename, all of the links in README are currently broken, but point to target location in main

dj8yfo · 2024-12-10T20:59:02Z

referencing SourceScan/verification-guide#1

dj8yfo · 2024-12-10T21:05:31Z

@race-of-sloths include

race-of-sloths · 2024-12-10T21:07:17Z

@dj8yfo Thank you for your contribution! Your pull request is now a part of the Race of Sloths!
Great job! Usain Bolt jealous of your results!

Current status: waiting for finalization

The pull request is merged, you have 24 hours to finalize your scoring. The scoring ends Thu Dec 12 12:30:03 2024

Reviewer	Score
@frol	5

Your contribution is much appreciated with a final score of 5!
You have received 50 Sloth points for this contribution

@frol received 25 Sloth Points for reviewing and scoring this pull request.

What is the Race of Sloths

Race of Sloths is a friendly competition where you can participate in challenges and compete with other open-source contributors within your normal workflow

For contributors:

Tag @race-of-sloths inside your pull requests
Wait for the maintainer to review and score your pull request
Check out your position in the Leaderboard
Keep weekly and monthly streaks to reach higher positions
Boast your contributions with a dynamic picture of your Profile

For maintainers:

Score pull requests that participate in the Race of Sloths and receive a reward
Engage contributors with fair scoring and fast responses so they keep their streaks
Promote the Race to the point where the Race starts promoting you
Grow the community of your contributors

Feel free to check our website for additional details!

Bot commands

For contributors
- Include a PR: @race-of-sloths include to enter the Race with your PR
For maintainers:
- Invite contributor @race-of-sloths invite to invite the contributor to participate in a race or include it, if it's already a runner.
- Assign points: @race-of-sloths score [1/2/3/5/8/13] to award points based on your assessment.
- Reject this PR: @race-of-sloths exclude to send this PR back to the drawing board.
- Exclude repo: @race-of-sloths pause to stop bot activity in this repo until @race-of-sloths unpause command is called

frol

@race-of-sloths score 5

this will look now like the following ```bash ❯ : cargo near build non-reproducible-wasm --help Runs on current filesystem state without many restrictions Usage: cargo-near near build non-reproducible-wasm [OPTIONS] Options: --locked --no-release --no-abi --no-embed-abi --no-doc --no-wasmopt --out-dir <OUT_DIR> --manifest-path <MANIFEST_PATH> --features <FEATURES> --no-default-features --color <COLOR> [possible values: auto, always, never] --env <ENV> -h, --help Print help -V, --version Print version ``` ```bash ❯ : cargo near build reproducible-wasm --help Requires `docker` config added and (git)committed to Cargo.toml, runs on clean (git)working tree state Usage: cargo-near near build reproducible-wasm [OPTIONS] Options: --no-locked --out-dir <OUT_DIR> --manifest-path <MANIFEST_PATH> --color <COLOR> [possible values: auto, always, never] -h, --help Print help -V, --version Print version ``` --- this is pending - [x] deploy cmd dispatch in current pr - [x] logic to enforce correct `container_build_command` for newer images (ones, that will be built after release of this pr) - [x] prettier indents in interactive help msgs in current pr - [x] separate pr onto current pr as base branch with tests fixed as per api change (#263) - [x] testing of this pr on a few common cases (sample-crate, factory-rust, neardevhub-contract) (in comment #262 (comment)) - [x] separate pr onto current pr as base branch with `.github/workflows` change /testing (#264) - [x] separate pr onto current pr as base branch with docs/README update (#265) - [ ] merge --------- Co-authored-by: dj8yf0μl <[email protected]>

doc: build interactive choice

66fe3ef

dj8yfo commented Dec 10, 2024

View reviewed changes

chore: rename Cargo.toml.template -> Cargo.template.toml for synt…

cb06e7a

…ax highlighting in gh

dj8yfo force-pushed the doc-reproducible-interactive branch from 5b56563 to cb06e7a Compare December 10, 2024 16:45

chore: add reference to SourceScan/verification-guide

4b9372b

dj8yfo force-pushed the doc-reproducible-interactive branch 2 times, most recently from a716ffe to 2d7bc0a Compare December 10, 2024 17:18

chore: trim pic and some links

eba71b8

dj8yfo force-pushed the doc-reproducible-interactive branch from 2d7bc0a to eba71b8 Compare December 10, 2024 17:26

chore: add mention about passed_env

d1c44ee

dj8yfo mentioned this pull request Dec 10, 2024

feat: reproducible choice interactive #262

Merged

8 tasks

dj8yfo commented Dec 10, 2024

View reviewed changes

chore: reword container_build_command description

3b7295c

dj8yfo commented Dec 10, 2024

View reviewed changes

dj8yfo force-pushed the doc-reproducible-interactive branch 3 times, most recently from fe57dd0 to 7dc1bdb Compare December 10, 2024 18:48

chore: reorder bullets

4753446

dj8yfo force-pushed the doc-reproducible-interactive branch from 7dc1bdb to 4753446 Compare December 10, 2024 18:57

dj8yfo marked this pull request as ready for review December 10, 2024 21:06

frol approved these changes Dec 11, 2024

View reviewed changes

frol merged commit 2732825 into if-reproducible-interactive Dec 11, 2024
17 checks passed

frol deleted the doc-reproducible-interactive branch December 11, 2024 12:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: edit README.md for reproducible choice interactive change #265

doc: edit README.md for reproducible choice interactive change #265

dj8yfo commented Dec 10, 2024 •

edited

Loading

dj8yfo Dec 10, 2024

dj8yfo Dec 10, 2024 •

edited

Loading

dj8yfo Dec 10, 2024 •

edited

Loading

dj8yfo commented Dec 10, 2024

dj8yfo commented Dec 10, 2024

race-of-sloths commented Dec 10, 2024 •

edited

Loading

frol left a comment

doc: edit README.md for reproducible choice interactive change #265

doc: edit README.md for reproducible choice interactive change #265

Conversation

dj8yfo commented Dec 10, 2024 • edited Loading

dj8yfo Dec 10, 2024

Choose a reason for hiding this comment

dj8yfo Dec 10, 2024 • edited Loading

Choose a reason for hiding this comment

dj8yfo Dec 10, 2024 • edited Loading

Choose a reason for hiding this comment

dj8yfo commented Dec 10, 2024

dj8yfo commented Dec 10, 2024

race-of-sloths commented Dec 10, 2024 • edited Loading

frol left a comment

Choose a reason for hiding this comment

dj8yfo commented Dec 10, 2024 •

edited

Loading

dj8yfo Dec 10, 2024 •

edited

Loading

dj8yfo Dec 10, 2024 •

edited

Loading

race-of-sloths commented Dec 10, 2024 •

edited

Loading