Skip to content

feat: dev and release pipelines #590

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
wants to merge 13 commits into
base: 0.29
Choose a base branch
from

Conversation

namsnath
Copy link
Contributor

Summary of change

(A few sentences about this PR)

Related issues

  • Link to issue1 here
  • Link to issue1 here

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!)

Documentation changes

(If relevant, please create a PR in our docs repo, or create a checklist here highlighting the necessary changes)

Checklist for important updates

  • Changelog has been updated
  • coreDriverInterfaceSupported.json file has been updated (if needed)
    • Along with the associated array in supertokens_python/constants.py
  • frontendDriverInterfaceSupported.json file has been updated (if needed)
  • Changes to the version if needed
    • In setup.py
    • In supertokens_python/constants.py
  • Had installed and ran the pre-commit hook
  • Issue this PR against the latest non released version branch.
    • To know which one it is, run find the latest released tag (git tag) in the format vX.Y.Z, and then find the latest branch (git branch --all) whose X.Y is greater than the latest released tag.
    • If no such branch exists, then create one from the latest released branch.
  • If have added a new web framework, update the supertokens_python/utils.py file to include that in the FRAMEWORKS variable
  • If added a new recipe that has a User type with extra info, then be sure to change the User type in supertokens_python/types.py
  • Make sure that syncio / asyncio functions are consistent.
  • If access token structure has changed
    • Modified test in tests/sessions/test_access_token_version.py to account for any new claims that are optional or omitted by the core

Remaining TODOs for this PR

  • Item1
  • Item2

@namsnath namsnath self-assigned this May 19, 2025
@namsnath namsnath requested review from porcellus and sattvikc May 19, 2025 12:37
@namsnath namsnath marked this pull request as ready for review June 9, 2025 10:25
Copy link

promptless bot commented Jun 9, 2025

✅ No documentation updates required.

-H 'api-version: 0' \
-d "{
\"password\": \"${{ secrets.SUPERTOKENS_API_KEY }}\",
\"version\":\"$${{ needs.setup.outputs.setupVersion }}\",
Copy link

Choose a reason for hiding this comment

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

There appears to be a syntax error in the JSON payload for the API call. The variable reference has a double dollar sign ($${{ needs.setup.outputs.setupVersion }}), which would cause the template variable to be incorrectly processed. This should be changed to a single dollar sign:

"version\":\"${{ needs.setup.outputs.setupVersion }}\",

This will ensure the correct version value is passed to the API.

Suggested change
\"version\":\"$${{ needs.setup.outputs.setupVersion }}\",
\"version\":\"${{ needs.setup.outputs.setupVersion }}\",

Spotted by Diamond

Is this helpful? React 👍 or 👎 to let us know.

run: |
testsPassed=`curl -s -X GET "https://api.supertokens.io/0/driver?password=${{ secrets.SUPERTOKENS_API_KEY }}&version=${{ needs.setup.outputs.setupVersion }}&name=python" -H 'api-version: 0'`

if [[ echo $testsPassed | jq .testPassed != "true" ]]
Copy link

Choose a reason for hiding this comment

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

There's a syntax error in the bash conditional. The current code attempts to pipe the output of echo directly into the conditional, but this isn't valid bash syntax.

The correct approach is to use command substitution:

if [[ $(echo $testsPassed | jq .testPassed) != "true" ]]

This properly captures the output of the jq command for comparison in the conditional statement.

Suggested change
if [[ echo $testsPassed | jq .testPassed != "true" ]]
if [[ $(echo $testsPassed | jq .testPassed) != "true" ]]

Spotted by Diamond

Is this helpful? React 👍 or 👎 to let us know.

Comment on lines +244 to +252
response=$(curl -s\
-X GET\
"https://api.supertokens.io/0/driver/latest/check?\
password=${{ secrets.SUPERTOKENS_API_KEY }}&\
version=${{ needs.setup.outputs.setupVersion }}&\
name=python" \
-H 'api-version: 0'
)
response=`curl -s -X GET "https://api.supertokens.io/0/driver/latest/check?password=${{ secrets.SUPERTOKENS_API_KEY }}&version=${{ needs.setup.outputs.setupVersion }}&name=python" -H 'api-version: 0'`
Copy link

Choose a reason for hiding this comment

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

There appears to be duplicate API calls here. The first multi-line curl command (lines 244-251) sets the response variable, but then it's immediately overwritten by the second curl command on line 252. Since both make the same API call, one of them should be removed to avoid redundancy and potential confusion.

Suggested change
response=$(curl -s\
-X GET\
"https://api.supertokens.io/0/driver/latest/check?\
password=${{ secrets.SUPERTOKENS_API_KEY }}&\
version=${{ needs.setup.outputs.setupVersion }}&\
name=python" \
-H 'api-version: 0'
)
response=`curl -s -X GET "https://api.supertokens.io/0/driver/latest/check?password=${{ secrets.SUPERTOKENS_API_KEY }}&version=${{ needs.setup.outputs.setupVersion }}&name=python" -H 'api-version: 0'`
response=$(curl -s\
-X GET\
"https://api.supertokens.io/0/driver/latest/check?\
password=${{ secrets.SUPERTOKENS_API_KEY }}&\
version=${{ needs.setup.outputs.setupVersion }}&\
name=python" \
-H 'api-version: 0'
)

Spotted by Diamond

Is this helpful? React 👍 or 👎 to let us know.

Comment on lines +191 to +192
echo "Current: `$currentTag`"
echo "Expected: `$expectedTag`"
Copy link

Choose a reason for hiding this comment

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

There's a syntax error in the string interpolation. The backticks around the variables will cause the shell to interpret them as commands rather than variable references. The correct syntax should be:

echo "Current: $currentTag"
echo "Expected: $expectedTag"

Remove the backticks around the variable names to properly display their values.

Suggested change
echo "Current: `$currentTag`"
echo "Expected: `$expectedTag`"
echo "Current: $currentTag"
echo "Expected: $expectedTag"

Spotted by Diamond

Is this helpful? React 👍 or 👎 to let us know.

\"name\": \"python\",
\"frontendDriverInterfaces\": ${{ steps.versions.outputs.fdiVersions }},
\"coreDriverInterfaces\": ${{ steps.versions.outputs.cdiVersions }}
}"`
Copy link

Choose a reason for hiding this comment

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

There's a syntax error in this line - an extra backtick appears at the end of the curl command after the closing JSON brace. This will cause the command to fail when executed. The backtick should be removed for proper syntax.

Suggested change
}"`
}"

Spotted by Diamond

Is this helpful? React 👍 or 👎 to let us know.

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.

2 participants