Skip to content

chore: Update dev/test environment#412

Merged
DaveSkender merged 29 commits intomainfrom
update-dev-container
May 27, 2025
Merged

chore: Update dev/test environment#412
DaveSkender merged 29 commits intomainfrom
update-dev-container

Conversation

@DaveSkender
Copy link
Member

@DaveSkender DaveSkender commented Jan 2, 2025

This PR updates the development environment and test configurations while improving compatibility with workspaces. Key changes include updating the dev container to use Python 3.12 and adding new VS Code configuration files for tasks, settings, launch, and extensions.

  • Update dev container to newer specs
  • Add related .vscode config files
  • Fix compatibility with Workspaces
  • Fix Marge conflicts, with bias towards base
  • refactor: updates to workflows
  • update docs site packages
details

the details

This pull request introduces a comprehensive update to the development environment configuration for the Python project, focusing on enhancing usability, consistency, and developer productivity. Key changes include upgrading the devcontainer setup, adding VS Code configurations for debugging and testing, and updating documentation to reflect the new environment setup.

Devcontainer and Environment Configuration Updates:

  • .devcontainer/devcontainer.json: Upgraded the Python version to 3.12 and added several development features, including Git, Node.js, Ruby, Azure CLI, and GitHub CLI. Updated post-create and post-start commands for better automation.
  • .devcontainer/setup.sh: Added a script to install core and test dependencies automatically after the container is created.

VS Code Configuration Enhancements:

  • .vscode/extensions.json: Defined recommended extensions for Python development, including linters, formatters, and debugging tools.
  • .vscode/launch.json: Added debugging configurations for running Python files and tests using debugpy.
  • .vscode/settings.json: Configured settings for isort, markdownlint, pylint, and Python testing to ensure consistency and enforce coding standards.
  • .vscode/tasks.json: Added predefined tasks for building dependencies, running unit tests, performance tests, localization tests, and coverage analysis.

Documentation Updates:

  • docs/contributing.md: Revised the "Development Environment" section to highlight the use of VS Code Dev Containers and tools like act for testing GitHub Actions workflows locally. Simplified instructions for new contributors. [1] [2]

and add baseline .vscode configs
@DaveSkender DaveSkender self-assigned this Jan 2, 2025
@DaveSkender DaveSkender changed the title chore: Update dev container chore: Dev/test environment update Jan 2, 2025
@DaveSkender DaveSkender changed the title chore: Dev/test environment update chore: Update dev/test environment Jan 2, 2025
@DaveSkender DaveSkender requested a review from Copilot January 2, 2025 12:06
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 98 out of 113 changed files in this pull request and generated no comments.

Files not reviewed (15)
  • .devcontainer/devcontainer.json: Language not supported
  • .devcontainer/install-dependencies.sh: Language not supported
  • .editorconfig: Language not supported
  • .gitattributes: Language not supported
  • .github/workflows/test-docs-a11y.yml: Language not supported
  • .github/workflows/test-docs-links.yml: Language not supported
  • .github/workflows/test-indicators-all-env.yml: Language not supported
  • .pylintrc: Language not supported
  • .vscode/extensions.json: Language not supported
  • .vscode/launch.json: Language not supported
  • .vscode/settings.json: Language not supported
  • .vscode/tasks.json: Language not supported
  • .github/workflows/deploy-website.yml: Evaluated as low risk
  • .github/workflows/test-indicators-ci.yml: Evaluated as low risk
  • .github/workflows/test-indicators-coverage.yml: Evaluated as low risk
Comments suppressed due to low confidence (2)

.github/workflows/test-indicators-full.yml:24

  • [nitpick] The variable name 'IS_PRIMARY' is ambiguous. It should be renamed to something more descriptive, such as 'IS_PRIMARY_INSTANCE'.
IS_PRIMARY: ${{ matrix.os == 'macos-latest' && matrix.python-version == '3.12' && matrix.dotnet-version == '8.x' }}

.github/workflows/test-indicators-full.yml:50

  • Ensure that the new behavior introduced by the changes is covered by tests.
run: pytest -vr A tests --junitxml=test-results.xml

@DaveSkender DaveSkender requested a review from Copilot May 27, 2025 17:40

This comment was marked as resolved.

@DaveSkender DaveSkender marked this pull request as ready for review May 27, 2025 17:43
@DaveSkender DaveSkender requested a review from Copilot May 27, 2025 17:43
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@DaveSkender DaveSkender requested a review from Copilot May 27, 2025 19:44

This comment was marked as resolved.

@DaveSkender DaveSkender merged commit cb52824 into main May 27, 2025
22 checks passed
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Stock Indicators for Python May 27, 2025
@DaveSkender DaveSkender deleted the update-dev-container branch May 27, 2025 21:44
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 2, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

2 participants