Skip to content

update: publish docs workflow #605

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 10 commits into
base: 0.30
Choose a base branch
from
Open

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

Copy link

promptless bot commented Jun 26, 2025

✅ No documentation updates required.

steps:
- uses: actions/checkout@v4
with:
ref: ${{ inputs.branch }}
Copy link
Contributor

Choose a reason for hiding this comment

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

The workflow is triggered by pull request events, but inputs.branch is undefined in this context since there are no workflow inputs defined. To properly reference the PR branch being built, use github.head_ref or github.event.pull_request.head.ref instead. For example:

ref: ${{ github.head_ref }}

This ensures the workflow checks out the correct branch that contains the changes being tested in the pull request.

Suggested change
ref: ${{ inputs.branch }}
ref: ${{ github.head_ref }}

Spotted by Diamond

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

mkdir -p $pythonDocDir/${{ needs.setup.outputs.versionFolder }}
cp -r supertokens-python/html/* $pythonDocDir/${{ needs.setup.outputs.versionFolder }}

if [[ "true" == "true" ]]
Copy link
Contributor

Choose a reason for hiding this comment

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

The condition [[ "true" == "true" ]] will always evaluate to true, making this conditional block execute unconditionally. If the intention is to conditionally execute this code based on whether the version is the latest, consider replacing this with [[ "${{ needs.setup.outputs.isLatest }}" == "true" ]] or another appropriate variable. If this code should always run, the conditional check can be removed entirely for clarity.

Suggested change
if [[ "true" == "true" ]]
if [[ "${{ needs.setup.outputs.isLatest }}" == "true" ]]

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.

1 participant