Skip to content

chore(mage): pin python requirements, update docs+mage#297

Open
dmcilvaney wants to merge 1 commit into
microsoft:mainfrom
dmcilvaney:damcilva/python-req-in
Open

chore(mage): pin python requirements, update docs+mage#297
dmcilvaney wants to merge 1 commit into
microsoft:mainfrom
dmcilvaney:damcilva/python-req-in

Conversation

@dmcilvaney

Copy link
Copy Markdown
Contributor

No description provided.

Copilot AI review requested due to automatic review settings July 24, 2026 00:28

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the repo’s Python lint/typecheck toolchain to use pinned pip requirements, and adjusts Mage targets/docs/CI/devcontainer so Python checks are treated as optional unless explicitly requested.

Changes:

  • Add requirements-lint.txt and switch CI/devcontainer/docs to install Python lint tools from it.
  • Introduce a mage check default target and update mage all to run default (Go) checks instead of check all.
  • Update developer documentation and devcontainer build context/copy paths to match the new installation flow.

Reviewed changes

Copilot reviewed 14 out of 15 changed files in this pull request and generated no comments.

Show a summary per file
File Description
requirements-lint.txt Adds pinned versions for Python lint/typecheck tools (ruff, pyright).
magefiles/magefile.go Updates mage all to run default checks instead of all checks.
magefiles/magecheckfix/checkfix.go Adds default check target and refactors all vs default check composition.
internal/app/azldev/core/sources/render_process.py Updates file header copyright line.
docs/developer/reference/coding-standards.md Documents installing pinned Python tools from requirements-lint.txt.
docs/developer/reference/build.md Clarifies tooling expectations and distinguishes check default vs check all.
docs/developer/how-to/get-started.md Updates Python setup to use a venv and install pinned lint requirements.
docs/developer/how-to/dev-workflow.md Updates recommended commands to reflect new mage all / Python-check behavior.
.gitignore Ignores common Python virtual environment directories.
.github/workflows/python.yml Installs Python lint tools from requirements-lint.txt in CI.
.github/dependabot.yml Adds Dependabot updates for pip-based Python lint tooling.
.github/copilot-instructions.md Updates agent guidance for when to run mage check all vs mage all.
.devcontainer/README.md Points devcontainer Python tool installation to pinned requirements.
.devcontainer/Dockerfile.AZL-3.0 Installs pinned Python lint tools and fixes COPY paths for repo-root build context.
.devcontainer/devcontainer.json Switches build context to repo root to support copying root files into the image.

# Install required packages
RUN tdnf -y update && \
tdnf -y install ca-certificates dnf dnf-utils which gh git golang gawk tar shadow-utils sudo tree bash-completion moby-engine moby-cli build-essential python3-pip nodejs && \
tdnf -y install ca-certificates dnf dnf-utils which gh git golang gawk tar shadow-utils sudo tree bash-completion moby-engine moby-cli build-essential python3-pip && \

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

note: pyright brings its own copy of nodejs

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