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.

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

Workshop Script Update #43

Merged
merged 24 commits into from
Oct 18, 2023
Merged

Workshop Script Update #43

merged 24 commits into from
Oct 18, 2023

Conversation

frank-aleo
Copy link

@frank-aleo frank-aleo commented Oct 11, 2023

Why

Added more expressive scripts that exposes echo commands being run and brief explanations for inputs and outputs. It doesn't take the place of the README.md (and eventual tutorial in the documentation), but offers much more of a standalone narrative in the terminal. The user can run the entire script, and then read their terminal to see commands and outputs without hopping around too much.

Changes

  • Added more expressive, narrative scripts, with the exception of battleship, since it's much more complex and the README.md does a better job.
  • Also added fixes on self.caller -> self.signer in the battleship example to ensure records are owned by the signer not the program owner.
  • Scripts have all been modified to use inputs inline, so when we remove input files, the scripts are independent from them and will not break.
  • All README.mds have been updated to the most current tutorial documentation (Frank workshop upgrades welcome#295)

Testing

All scripts have been tested locally. They compile and run end to end without errors.

🎉

Copy link
Contributor

@collinc97 collinc97 left a comment

Choose a reason for hiding this comment

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

Auction example feedback

auction/README.md Outdated Show resolved Hide resolved
auction/README.md Outdated Show resolved Hide resolved
auction/README.md Outdated Show resolved Hide resolved
auction/run.sh Outdated Show resolved Hide resolved
@collinc97
Copy link
Contributor

@frank-aleo Can you remove the input files for the workshop examples in this PR as well?
This will prevent downstream breakages over the next Leo release

@frank-aleo
Copy link
Author

Appreciate the comments and review @collinc97.

  1. Added steps back to the README.md so it matches run scripts.
  2. Simplified "how to run", added correct links, added explainers.
  3. Removed all input files from examples.

@collinc97 collinc97 merged commit f1738a7 into master Oct 18, 2023
@collinc97 collinc97 deleted the frank-workshop-upgrades branch October 18, 2023 00:09
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.

3 participants