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

AVM: Generate langspec for each version #5629

Merged
merged 12 commits into from
Aug 26, 2023

Conversation

jasonpaulos
Copy link
Contributor

Summary

Addresses #5131, which asks for a langpsec.json file to be generated for each TEAL version.

I've also generated the TEAL_opcodes.md file for each version, since I view this as the human-readable equivalent of langspec.json.

Now the files langpsec_v%d.json and TEAL_opcodes_v%d.md will be generated for each version.

Test Plan

Documentation-only change

@codecov
Copy link

codecov bot commented Aug 2, 2023

Codecov Report

Merging #5629 (d3bec9f) into master (572d728) will decrease coverage by 0.04%.
Report is 1 commits behind head on master.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #5629      +/-   ##
==========================================
- Coverage   55.36%   55.32%   -0.04%     
==========================================
  Files         466      466              
  Lines       65733    65723      -10     
==========================================
- Hits        36394    36364      -30     
- Misses      26883    26906      +23     
+ Partials     2456     2453       -3     
Files Changed Coverage Δ
data/transactions/logic/doc.go 70.96% <ø> (-4.04%) ⬇️
data/transactions/logic/opcodes.go 79.84% <ø> (-3.62%) ⬇️

... and 12 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Contributor

@jannotti jannotti left a comment

Choose a reason for hiding this comment

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

We'll have to coordinate with the process that gets the docs onto the website, since there is no TEAL_opcodes.md any more. I imagine we either want to create it, as a copy of the last version or (I think better) the process that copies them into place should copy and link to them all. @JasonWeathersby

data/transactions/logic/TEAL_opcodes_v8.md Show resolved Hide resolved
@jasonpaulos
Copy link
Contributor Author

Created algorandfoundation/docs#1156 to update the docs site with this change.

jannotti
jannotti previously approved these changes Aug 24, 2023
Copy link
Contributor

@jannotti jannotti left a comment

Choose a reason for hiding this comment

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

Looks good to me. I'd like to get this merged soon, so I can work out how it changes the process of giving spec changes to the Foundation. (probably pretty minimal)

cmd/opdoc/opdoc.go Outdated Show resolved Hide resolved
bbroder-algo
bbroder-algo previously approved these changes Aug 24, 2023
@jasonpaulos jasonpaulos dismissed stale reviews from bbroder-algo and jannotti via 786ac77 August 25, 2023 16:36
jannotti
jannotti previously approved these changes Aug 25, 2023
@bbroder-algo bbroder-algo merged commit ca420de into algorand:master Aug 26, 2023
10 checks passed
@jasonpaulos jasonpaulos deleted the multi-version-langspec branch August 28, 2023 13:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants