Skip to content

chore: update gradlew command in developer guide#2695

Open
brutalsachin wants to merge 1 commit intohiero-ledger:mainfrom
brutalsachin:fix-doc-update
Open

chore: update gradlew command in developer guide#2695
brutalsachin wants to merge 1 commit intohiero-ledger:mainfrom
brutalsachin:fix-doc-update

Conversation

@brutalsachin
Copy link
Copy Markdown

@brutalsachin brutalsachin commented Apr 3, 2026

This PR fixes the incorrect gradlew command in developer-guide.md.

Changes:

  • Replaced ./gradlew updateSnapshots with ./gradlew updateProto
  • Added note about checkout_ref variable in update_protobufs.py

Fixes #2694

Signed-off-by: Sachin Yadav <sachinyadav578478@gmail.com>
@codacy-production
Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

TIP This summary will be updated as you push new changes. Give us feedback

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the SDK developer guide to correct the Gradle command used for regenerating protobuf sources and adds guidance about selecting the protobuf reference used by the update script.

Changes:

  • Replaced the proto update command from ./gradlew updateSnapshots to ./gradlew updateProto.
  • Added a note about updating the checkout_ref used by update_protobufs.py before running the proto update task.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines 129 to 132
```sh
./gradlew updateSnapshots
./gradlew updateProto
Note: checkout_ref variable in update_protobufs.py should be updated with the version with needed protobufs before running the command
```
Copy link

Copilot AI Apr 3, 2026

Choose a reason for hiding this comment

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

The "Note:" line is inside the fenced sh code block, so copying/pasting the snippet will try to execute it as a shell command and fail. Move the note outside the code fence (e.g., as a Markdown blockquote) and consider referencing the actual path scripts/update_protobufs.py plus clearer wording about what checkout_ref should be set to.

Copilot uses AI. Check for mistakes.
@brutalsachin
Copy link
Copy Markdown
Author

Hi, I have addressed the review feedback. Please let me know if anything else is needed. Thank you!

@mustafauzunn mustafauzunn changed the title fix: update gradlew command in developer guide chore: update gradlew command in developer guide Apr 6, 2026
Copy link
Copy Markdown
Contributor

@mustafauzunn mustafauzunn left a comment

Choose a reason for hiding this comment

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

@brutalsachin Thanks for the contribution! 🎉

Please move the Note outside of the sh block and also sign commits with gpg

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Good First Issue]: Update developer-guide.md

3 participants