diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index e10b7d0d..675a0099 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -2,7 +2,7 @@ name: Main Workflow on: push: - branches: [ main ] + branches: [ staging ] pull_request: workflow_dispatch: inputs: @@ -22,4 +22,7 @@ jobs: uses: ./.github/workflows/test.yml with: python-version: ${{ inputs.python-version || '3.11' }} + permissions: + id-token: write + contents: read secrets: inherit diff --git a/README.md b/README.md index c24d1796..edcfd4ff 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ This library provides an S3 client that supports client-side encryption. ### Prerequisites - Python 3.11 or higher -- [Poetry](https://python-poetry.org/) for dependency management +- [uv](https://github.com/astral-sh/uv) for package and project management ### Setup @@ -73,3 +73,13 @@ Common Flake8 issues in the codebase include: - **Code complexity** (C901): Refactor complex functions When contributing to this project, please try to fix linting issues in the files you modify. + +### Pull Request Command +While this project is in development, +it is useful to use `gh pr` to create the pull-requests, +so they can be associated with the GitHub project. + +```sh +gh pr create -B staging -p "S3EC-Python" -f +``` + diff --git a/pyproject.toml b/pyproject.toml index 883b6914..187b99a2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -19,7 +19,8 @@ test = [ "pytest>=8.4.1", ] dev = [ - "black>=24.3.0", + # black >= 26 requires a reformat + "black>=24.3.0,<26.0.0", "ruff>=0.3.0", ] @@ -52,3 +53,6 @@ max-complexity = 10 [tool.ruff.lint.isort] known-first-party = ["s3_encryption"] + +[tool.ruff.lint.per-file-ignores] +"test/**/*.py" = ["D100", "D101", "D102", "D103", "D104", "E501"]