foundry-rs / starknet-foundry

Blazing fast toolkit for developing Starknet contracts.
https://foundry-rs.github.io/starknet-foundry/
MIT License
328 stars 178 forks source link

Update release script to update versions in docs #2329

Open tomek0123456789 opened 4 months ago

tomek0123456789 commented 4 months ago

Which component is your feature related to?

Other (Please describe below)

Feature Request

There is a script (./scripts/release.sh) that is supposed to prepare the code in repo for the starknet-foundry release. It does a few things, amongst which are version bumps in Scarb.toml-s in crates and snforge/sncast stds.

It would be nice if the script could bump the versions in docs as well.

Proposed steps:

Definition of done:

CollinsC1O commented 1 month ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hello I'm a front-end and a blockchain developer and will love to work on this issue please assign

ikemHood commented 1 month ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hello @tomek0123456789, I would love to do this

How I plan on tackling this issue

First, create a list of documentation files to update

DOC_FILES=(
    "./docs/src/getting-started/first-steps.md"
    "./docs/src/starknet/script.md"
    "./docs/src/appendix/scarb-toml.md"
    "./docs/src/appendix/cheatcodes.md"
    "./docs/src/appendix/snforge-library.md"
    "./docs/src/testing/contracts.md"
    "./docs/src/testing/using-cheatcodes.md"
)

Then, Add a function to update version in documentation files,

Then, Add a loop to process all documentation files,

Finally, Add a verification step to confirm the versions were bumped.

Mystic-Nayy commented 1 month ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I am a web3 developer @franciszekjob Can I be assigned to work on this?

How I plan on tackling this issue

To update the release.sh script for version bumps in documentation:

  1. Modify the Script: Add functionality to ./scripts/release.sh to search for version placeholders in specified documentation files.
  2. Implement Replacement Logic: Ensure the script replaces old version numbers with the new version during the release process.
  3. Test Changes: Run the updated script to verify that the versions in the documentation files are accurately updated and persist correctly.
martinvibes commented 1 month ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

hello @ i'm an experienced frontend developer and a blockchain developer i would love to work on this issue Pleasee kindly assign :)

How I plan on tackling this issue

i would make sure ito read and understand the issue well and then implement it

mexes20 commented 1 month ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hello, can I be assigned to work on this issue?

I'm a software developer with over 6 years experience

ETA: One day

raizo07 commented 1 month ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hello, can I be assigned to work on this issue?

I'm a software developer with over 4 years experience

Here's my OnlyDust profile https://app.onlydust.com/u/raizo07

ETA: One day

THenry14 commented 1 month ago

Hi @raizo07 , hope everything's going well. Just wanted to touch base and ask if you have any updates on this? thanks

raizo07 commented 1 month ago

@THenry14 Working on it already, will make a pr soon.