forked from tlaplus/Examples
-
Notifications
You must be signed in to change notification settings - Fork 0
Update EWD998PCal.tla comments #2
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
Open
lemmy
wants to merge
2
commits into
master
Choose a base branch
from
mku-comments
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
// metadata (including model parameters) | ||
// learn more at https://aka.ms/genaiscript | ||
script({ title: "tlAI-Linter", description: "Check if the prose comments and their TLA+ declarations and definitions are syntactically and semantically consistent" }) | ||
|
||
// use def to emit LLM variables | ||
def("TLA+", env.files.filter(f => f.filename.endsWith(".tla")), {lineNumbers: true}) | ||
|
||
// use $ to output formatted text to the prompt | ||
$`You are an expert at TLA+/TLAPLUS. Your task is to check if the prose comments and their TLA+ declarations and definitions are syntactically and semantically consistent!!! | ||
Explain any consistencies and inconsistencies you may find. Report inconsistent and consistent pairs in a single ANNOTATION section. | ||
|
||
## TLA+ Syntax Hints | ||
- A formula [A]_v is called a temporal formula, and is shorthand for the formula A \/ v' = v. In other words, the formula is true if A is true or if the value of v remains unchanged. Usually v is a tuple of the spec's variables. | ||
- The symbol \`#\` is alternative syntax used for inequality in TLA+; the other symbol is \`/=\". | ||
|
||
## TLA+ Semantics Hints | ||
- Do NOT add any invariants or properties to the behavior specification Spec or any of its subformulas. This would change THEOREM Spec => Inv into THEOREM Spec /\ Inv => Inv, which is vacuously true. | ||
- TLA+ specs are always stuttering insensitive, i.e., the next-state relation is always [A]_v. In other words, one cannot write a stuttering sensitive specification. | ||
|
||
## TLA+ Convention Hints | ||
- The type correctness invariant is typically called TypeOK. | ||
- Users can employ TLA labels as a means to conceptually associate a comment with a sub-formula like a specific disjunct or conjunct of a TLA formula. Even though these labels have no other function, they facilitate referencing particular parts of the formula from a comment. | ||
|
||
## Formal and informal math Hints | ||
- Take into account that humans may write informal math that is syntactically different from the formal math, yet semantically equivalent. For example, humans may write \`N > 3T\` instead of \`N > 3 * T\`. | ||
` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
name: tlAI-linter | ||
|
||
on: | ||
pull_request: | ||
branches: | ||
- master | ||
|
||
jobs: | ||
linting: | ||
name: tlAI-linter | ||
|
||
runs-on: ubuntu-latest | ||
|
||
env: | ||
## https://microsoft.github.io/genaiscript/reference/token/ | ||
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }} | ||
OPENAI_API_BASE: ${{ secrets.OPENAI_API_BASE }} | ||
OPENAI_API_TYPE: ${{ secrets.OPENAI_API_TYPE }} | ||
|
||
defaults: | ||
run: | ||
shell: bash | ||
|
||
steps: | ||
- name: Clone repo | ||
uses: actions/checkout@v4 | ||
with: | ||
## All history for git diff below to succeed. | ||
fetch-depth: 0 | ||
|
||
- name: Setup NodeJS | ||
## https://github.com/actions/setup-node | ||
uses: actions/setup-node@v4 | ||
with: | ||
node-version: "20" | ||
|
||
- name: Run GenAIscript on the TLA+ specs that are added in this pull request. | ||
## Identify git diff: $(git diff --name-only HEAD^ | grep '.tla') | ||
## Install genaiscript runtime: https://microsoft.github.io/genaiscript/reference/cli/ | ||
## Output LLM response in SARIF format: https://microsoft.github.io/genaiscript/reference/scripts/annotations/ | ||
run: npx --yes genaiscript-cli run .github/scripts/tlAI-Linter.genai.js $(git diff --name-only HEAD^ | grep '.tla') -oa results.sarif > /dev/null | ||
|
||
- name: Upload SARIF file | ||
## https://sarifweb.azurewebsites.net | ||
## https://docs.github.com/en/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github | ||
if: success() || failure() | ||
uses: github/codeql-action/upload-sarif@v3 | ||
with: | ||
sarif_file: results.sarif |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is cool :D
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://github.com/microsoft/tlaplus-examples/issues/3 and https://github.com/microsoft/tlaplus-examples/issues/1 show when and where it worked.