Merge branch 'develop' into tawsif/fix-imports

Author: codegen-bot

.github/actions/run-ats/ats.sh

@@ -50,7 +50,7 @@ if [ ! -s codecov_ats/tests_to_run.txt ]; then
     echo "No tests to run, collecting from default tests"
     PYTEST_ARGS="${COLLECT_ARGS} ${DEFAULT_TESTS}"
     echo "Using args: ${PYTEST_ARGS}"
-    TESTS_TO_RUN=$(PYTEST_ARGS=${PYTEST_ARGS} ./.circleci/collect.sh)
+    TESTS_TO_RUN=$(PYTEST_ARGS=${PYTEST_ARGS} ./.github/actions/run-ats/collect.sh)
     echo "${TESTS_TO_RUN}" > codecov_ats/tests_to_run.txt
     run_count=1
     echo "Added ${TESTS_TO_RUN} as fallback. New run count: $run_count"

.github/actions/run-ats/collect.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+TESTS_TO_RUN=$(uv run --frozen pytest --collect-only ${PYTEST_ARGS} -q --disable-warnings --no-summary --no-header)
+TESTS_TO_RUN=$(echo "${TESTS_TO_RUN}" | head -n -2)
+echo $TESTS_TO_RUN

.github/workflows/auto-release.yml

@@ -35,6 +35,40 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
+  generate-changelog:
+    if: ${{ needs.semantic-version.outputs.release-tag }}
+    needs: semantic-version
+    name: Generate Changelog
+    runs-on: ubuntu-latest
+    environment: auto-release
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GHA_TOKEN }}
+
+      - name: Setup backend
+        uses: ./.github/actions/setup-environment
+
+      - name: Generate changelog
+        env:
+          OPEN_AI_TOKEN: ${{ secrets.OPEN_AI_TOKEN }}
+        run: uv run python src/codegen/gscli/cli.py generate changelog --openai-key ${{ secrets.OPEN_AI_TOKEN }}
+
+      - name: Commit changes
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git add docs/changelog/changelog.mdx
+          git diff --staged --quiet || git commit -m "update changelog"
+
+      - name: Push changes
+        uses: ad-m/github-push-action@master
+        with:
+          branch: ${{ github.ref }}
+
   release:
     if: ${{ needs.semantic-version.outputs.release-tag }}
     needs: semantic-version

.github/workflows/generate-docs.yml

@@ -0,0 +1,37 @@
+name: Generate Documentation
+
+on:
+  push:
+    branches:
+      - develop
+
+permissions:
+  contents: write  # Need write permission to commit changes
+
+jobs:
+  generate-docs:
+    environment: auto-release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GHA_TOKEN }}
+
+      - name: Setup backend
+        uses: ./.github/actions/setup-environment
+
+      - name: Generate API reference
+        run: uv run python src/codegen/gscli/cli.py generate docs
+
+      - name: Commit changes
+        run: |
+          git config --local user.email ${{ secrets.DOCS_USER_EMAIL }}
+          git config --local user.name ${{ secrets.DOCS_USER_NAME }}
+          git add docs/
+          git diff --staged --quiet || git commit -m "docs: updated API reference"
+
+      - name: Push changes
+        uses: ad-m/github-push-action@master
+        with:
+          branch: ${{ github.ref }}

.github/workflows/pre-commit.yml

@@ -12,15 +12,15 @@ jobs:
   pre-commit:
     runs-on: ubuntu-latest
     timeout-minutes: 10
+    env:
+      REPO_SCOPED_TOKEN: ${{ secrets.REPO_SCOPED_TOKEN }}
 
     steps:
       - name: Check out the repo
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-          repository: ${{ github.event.pull_request.head.repo.full_name }}
-          ref: ${{ github.event.pull_request.head.ref }}
-          token: ${{ secrets.REPO_SCOPED_TOKEN || github.token }}
+          token: ${{ env.REPO_SCOPED_TOKEN || github.token }}
 
       - name: Setup environment
         uses: ./.github/actions/setup-environment
@@ -36,12 +36,9 @@ jobs:
 
       - run: uv run --frozen pre-commit run --show-diff-on-failure --color=always --all-files --source ${{ github.event.pull_request.base.sha || github.event.before }} --origin ${{ github.event.pull_request.head.sha || github.event.after }}
         shell: bash
-        env:
-          SKIP: circleci_validate
 
       - uses: stefanzweifel/git-auto-commit-action@v5
-        # Always commit changes even if pre-commit failed
-        if: always() && github.event_name == 'pull_request'
+        if: ${{ always() && env.REPO_SCOPED_TOKEN && github.event_name == 'pull_request' }}
         with:
           commit_message: "Automated pre-commit update"
           push_options: "--no-verify"

.github/workflows/unit-tests.yml renamed to .github/workflows/test.yml

@@ -1,24 +1,38 @@
-name: Unit Tests
+name: Tests
 
 on:
   push:
     branches:
       - "develop"
-  pull_request:
+  pull_request_target:
     types: [ opened, synchronize, reopened, labeled ]
     branches:
       - "develop"
   workflow_dispatch:
 
 jobs:
+  access-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions-cool/check-user-permission@v2
+        with:
+          require: write
+          username: ${{ github.triggering_actor }}
+          error-if-missing: true
+
   unit-tests:
+    needs: access-check
     runs-on: ubuntu-latest-8
+    environment: testing
     steps:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
+          ref: ${{ github.event.pull_request.head.sha }}
+
       - name: Setup environment
         uses: ./.github/actions/setup-environment
+
       - name: Run ATS and Tests
         uses: ./.github/actions/run-ats
         timeout-minutes: 15
@@ -30,9 +44,11 @@ jobs:
           codecov_flags: unit-tests
 
   codemod-tests:
+    needs: access-check
     # TODO: re-enable when this check is a develop required check
     if: false
     runs-on: ubuntu-latest-32
+    environment: testing
     strategy:
       matrix:
         sync_graph: [ true, false ]
@@ -48,10 +64,15 @@ jobs:
     name: "Codemod tests ${{matrix.size}}: Sync Graph=${{matrix.sync_graph}}"
     steps:
       - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+
       - name: Setup environment
         uses: ./.github/actions/setup-environment
+
       - name: Cache oss-repos
         uses: ./.github/actions/setup-oss-repos
+
       - name: Run ATS and Tests
         uses: ./.github/actions/run-ats
         timeout-minutes: 15
@@ -66,11 +87,15 @@ jobs:
           GITHUB_WORKSPACE: $GITHUB_WORKSPACE
 
   parse-tests:
-    runs-on: ubuntu-latest-32
+    needs: access-check
     if: contains(github.event.pull_request.labels.*.name, 'parse-tests') || github.event_name == 'push' || github.event_name == 'workflow_dispatch'
-    environment: parse-tests
+    runs-on: ubuntu-latest-32
+    environment: testing
     steps:
       - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+
       - name: Setup environment
         uses: ./.github/actions/setup-environment
 
@@ -91,10 +116,12 @@ jobs:
             -n auto \
             -o junit_suite_name="${{github.job}}" \
             tests/integration/codemod/test_parse.py
+
       - uses: ./.github/actions/report
         with:
           flag: no-flag
           codecov_token: ${{ secrets.CODECOV_TOKEN }}
+
       - name: Notify parse tests failure
         uses: slackapi/[email protected]
         if: failure() && github.event_name == 'push' && false
@@ -132,11 +159,17 @@ jobs:
             }
 
   integration-tests:
+    needs: access-check
     runs-on: ubuntu-latest-16
+    environment: testing
     steps:
       - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+
       - name: Setup environment
         uses: ./.github/actions/setup-environment
+
       - name: Test with pytest
         timeout-minutes: 5
         env:
@@ -147,6 +180,7 @@ jobs:
             -n auto \
             -o junit_suite_name="${{github.job}}" \
             tests/integration/codegen
+
       - uses: ./.github/actions/report
         with:
           flag: integration-tests

CONTRIBUTING.md

@@ -51,6 +51,10 @@ uv run pytest tests/unit -n auto
 uv run pytest tests/integration/codemod/test_codemods.py -n auto
 ```
 
+> [!TIP]
+>
+> - If on Linux the error `OSError: [Errno 24] Too many open files` appears then you might want to increase your _ulimit_
+
 ## Pull Request Process
 
 1. Fork the repository and create your branch from `develop`.

Dockerfile

@@ -3,7 +3,6 @@ ARG CODEGEN_BOT_GHE_TOKEN=""
 FROM ghcr.io/astral-sh/uv:python${PYTHON_VERSION}-bookworm-slim AS base_uv
 ENV UV_COMPILE_BYTECODE=1 UV_LINK_MODE=copy
 ENV GITHUB_WORKSPACE=/workspace
-LABEL com.circleci.preserve-entrypoint=true
 ## Change the working directory to the `codegen-sdk` directory
 FROM base_uv AS install-tools
 RUN apt-get update && apt-get install -y build-essential curl git

docs/api-reference/core/Class.mdx

@@ -11,7 +11,7 @@ import {HorizontalDivider} from '/snippets/HorizontalDivider.mdx';
 import {GithubLinkNote} from '/snippets/GithubLinkNote.mdx';
 import {Attribute} from '/snippets/Attribute.mdx';
 
-<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L53-L417" />
+<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L55-L419" />
 
 ### Inherits from
 [HasBlock](/api-reference/core/HasBlock), [Callable](/api-reference/core/Callable), [Expression](/api-reference/core/Expression), [Usable](/api-reference/core/Usable), [Symbol](/api-reference/core/Symbol), [Editable](/api-reference/core/Editable), [Importable](/api-reference/core/Importable), [HasName](/api-reference/core/HasName)
@@ -147,7 +147,7 @@ import {Attribute} from '/snippets/Attribute.mdx';
 <HorizontalDivider />
 ### <span className="text-primary">add_attribute</span>
 Adds an attribute to a class from another class.
-<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L358-L381" />
+<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L360-L383" />
 
 <ParameterWrapper>
 <Parameter
@@ -170,7 +170,7 @@ Adds an attribute to a class from another class.
 
 ### <span className="text-primary">add_attribute_from_source</span>
 Adds an attribute to a class from raw source code, placing it in a specific location
-<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L332-L355" />
+<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L334-L357" />
 
 <ParameterWrapper>
 <Parameter
@@ -244,7 +244,7 @@ Insert a keyword in the appropriate place before this symbol if it doesn't alrea
 
 ### <span className="text-primary">add_source</span>
 Add a block of source code to the bottom of a class definition.
-<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L318-L329" />
+<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L320-L331" />
 
 <ParameterWrapper>
 <Parameter
@@ -269,7 +269,7 @@ Find all ancestors of the node of the given type. Does not return itself
 
 ### <span className="text-primary">attributes</span>
 Retrieves all attributes from this Class including those from its superclasses up to a
-<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L272-L291" />
+<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L274-L293" />
 
 <ParameterWrapper>
 <Parameter
@@ -404,7 +404,7 @@ Adds a visual flag comment to the end of this Editable's source text.
 
 ### <span className="text-primary">get_attribute</span>
 Returns a specific attribute by name.
-<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L294-L311" />
+<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L296-L313" />
 
 <ParameterWrapper>
 <Parameter
@@ -421,7 +421,7 @@ Returns a specific attribute by name.
 
 ### <span className="text-primary">get_method</span>
 Returns a specific method by name from the class or any of its superclasses.
-<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L251-L268" />
+<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L253-L270" />
 
 <ParameterWrapper>
 <Parameter
@@ -446,7 +446,7 @@ Returns the name node of the object.
 
 ### <span className="text-primary">get_nested_class</span>
 Returns a nested class by name from the current class.
-<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L234-L248" />
+<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L236-L250" />
 
 <ParameterWrapper>
 <Parameter
@@ -514,7 +514,7 @@ Retrieves a parameter from the callable by its type.
 
 ### <span className="text-primary">get_parent_class</span>
 Returns the parent class node with the specified name.
-<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L111-L123" />
+<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L113-L125" />
 
 <ParameterWrapper>
 <Parameter
@@ -642,7 +642,7 @@ Inserts text before the current symbol node in the Abstract Syntax Tree.
 
 ### <span className="text-primary">is_subclass_of</span>
 Checks if the class inherits from a specified parent class.
-<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L138-L152" />
+<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L140-L154" />
 
 <ParameterWrapper>
 <Parameter
@@ -673,7 +673,7 @@ Check if this node is contained another node of the given class
 
 ### <span className="text-primary">methods</span>
 Retrieves all methods that exist on this Class, including methods from superclasses, with
-<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L203-L231" />
+<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L205-L233" />
 
 <ParameterWrapper>
 <Parameter
@@ -937,7 +937,7 @@ Sets the name of a code element.
 
 ### <span className="text-primary">subclasses</span>
 Returns all classes which subclass this class.
-<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L156-L167" />
+<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L158-L169" />
 
 <ParameterWrapper>
 <Parameter
@@ -954,7 +954,7 @@ Returns all classes which subclass this class.
 
 ### <span className="text-primary">superclasses</span>
 Returns a list of all classes that this class extends, up to max_depth.
-<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L77-L93" />
+<GithubLinkNote link="https://github.com/codegen-sh/codegen-sdk/blob/develop/src/codegen/sdk/core/class_definition.py#L79-L95" />
 
 <ParameterWrapper>
 <Parameter