Merge branch 'master' into merge

Author: alexef

.github/workflows/main.yml

@@ -2,9 +2,13 @@ name: CI
 
 on: [push]
 
+concurrency:
+  group: ${{ github.workflow }}${{ github.ref_name != github.event.repository.default_branch && github.ref || github.run_id }}
+  cancel-in-progress: ${{ github.ref_name != github.event.repository.default_branch }}
+
 jobs:
   test:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     strategy:
       matrix:
         python-version: [3.12, 3.9]
@@ -13,32 +17,32 @@ jobs:
       IS_COVERAGE_ALLOWED: ${{ secrets.CODACY_PROJECT_TOKEN != '' }}
       IS_MASTER_BRANCH: ${{ github.ref == 'refs/heads/master' }}
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install poetry
-      uses: abatilo/actions-poetry@v2.0.0
-      with:
-        poetry-version: ${{ matrix.poetry-version }}
-    - name: Install pip dependencies
-      run: poetry install
-    - name: Run tests
-      run: poetry run pytest --cov-report xml --cov=autopr test/ -v
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install poetry
+        uses: abatilo/actions-poetry@v2.0.0
+        with:
+          poetry-version: ${{ matrix.poetry-version }}
+      - name: Install pip dependencies
+        run: poetry install
+      - name: Run tests
+        run: poetry run pytest --cov-report xml --cov=autopr test/ -v
   lint:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python
-      uses: actions/setup-python@v2
-      with:
-        python-version: 3.9
-    - name: Install poetry
-      uses: abatilo/actions-poetry@v2.0.0
-      with:
-        poetry-version: 1.3.1
-    - name: Install pip dependencies
-      run: poetry install
-    - name: Run pre-commit
-      run: poetry run pre-commit run --all-files --show-diff-on-failure
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+      - name: Install poetry
+        uses: abatilo/actions-poetry@v2.0.0
+        with:
+          poetry-version: 1.3.1
+      - name: Install pip dependencies
+        run: poetry install
+      - name: Run pre-commit
+        run: poetry run pre-commit run --all-files --show-diff-on-failure

.github/workflows/publish.yml

@@ -4,25 +4,29 @@ on:
   release:
     types: [published]
 
+concurrency:
+  group: ${{ github.workflow }}${{ github.ref_name != github.event.repository.default_branch && github.ref || github.run_id }}
+  cancel-in-progress: ${{ github.ref_name != github.event.repository.default_branch }}
+
 jobs:
   publish:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@master
-    - uses: actions/setup-python@v1
-      with:
-        python-version: 3.9
-    - name: Install poetry
-      uses: abatilo/actions-poetry@v2.0.0
-      with:
-        poetry-version: 1.3.1
-    - name: Install pip dependencies
-      run: poetry install
-    - name: Package
-      run: |
-        poetry build
-    - name: Publish to PyPI
-      uses: pypa/gh-action-pypi-publish@v1.8.8
-      with:
-        user: __token__
-        password: ${{ secrets.pypi_token }}
+      - uses: actions/checkout@master
+      - uses: actions/setup-python@v1
+        with:
+          python-version: 3.9
+      - name: Install poetry
+        uses: abatilo/actions-poetry@v2.0.0
+        with:
+          poetry-version: 1.3.1
+      - name: Install pip dependencies
+        run: poetry install
+      - name: Package
+        run: |
+          poetry build
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@v1.8.8
+        with:
+          user: __token__
+          password: ${{ secrets.pypi_token }}

CHANGELOG.md

@@ -1,7 +1,11 @@
 # Changelog
 
-## 1.0.8
+## 1.0.9
+
 - Add `merge` command
+- Add `--api-key` flag to `auto-pr run` command
+  - Allows you to pass the API key as a flag (or as the env APR_API_KEY variable) instead of storing
+  it in the configuration file
 
 ## 1.0.7
 - Add `--exclude-missing` when running `auto-pr status`

README.md

@@ -59,6 +59,8 @@ update_command:
   - my-file
 ```
 
+If you wish to keep your API Key outside of `config.yaml`, set the env var `APR_API_KEY` with your GitHub Token
+
 ### Repositories
 
 You can define the list of repositories to pull and build into the database to update using a list of rules.

autopr/__init__.py

@@ -197,9 +197,18 @@ def test(pull_repos: bool):
     default=DEFAULT_PUSH_DELAY,
     help="Delay in seconds between pushing changes to repositories",
 )
-def run(pull_repos: bool, push_delay: Optional[float]):
+@click.option(
+    "--api-key",
+    envvar="APR_API_KEY",
+    required=False,
+    hide_input=True,
+    help="The GitHub API key to use if not statically configured",
+)
+def run(pull_repos: bool, push_delay: Optional[float], api_key: Optional[str]):
     """Run update logic and create pull requests if changes made"""
     cfg = workdir.read_config(WORKDIR)
+    if api_key is not None:
+        cfg.credentials.api_key = api_key
     db = workdir.read_database(WORKDIR)
     _ensure_set_up(cfg, db)
     gh = github.create_github_client(cfg.credentials.api_key)

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "auto-pr"
-version = "1.0.8"
+version = "1.0.9"
 description = "Perform bulk updates across repositories"
 license = "Apache-2.0"
 

pyproject.toml

@@ -1,6 +1,7 @@
 import subprocess
 from pathlib import Path
 from test.test_utils import (
+    env_var_token_test_config,
     init_git_repos,
     run_cli,
     simple_test_config,
@@ -43,3 +44,21 @@ def test_create_files(_create_github_client: Mock, tmp_path):
         db=db,
     )
     print(result.output)
+
+
+@patch("autopr.repo.run_cmd", new=_test_cmd)
+@patch("autopr.github.create_github_client")
+def test_api_key_env_var(_create_github_client: Mock, monkeypatch, tmp_path):
+    wd = workdir.WorkDir(Path(tmp_path))
+    db = simple_test_database()
+    init_git_repos(wd, db)
+    result = run_cli(
+        wd,
+        ["run"],
+        cfg=env_var_token_test_config(),
+        env={"APR_API_KEY": "env_var_test"},
+        db=db,
+    )
+    assert (
+        _create_github_client.call_args_list[0][0][0] == "env_var_test"
+    ), f"wrong api_key used for create_github_client: {_create_github_client.call_args_list}"

test/test_run.py

@@ -12,6 +12,7 @@ def run_cli(
     cmd: List[str],
     cfg: Optional[config.Config] = None,
     db: Optional[database.Database] = None,
+    env: Optional[dict] = None,
     should_fail: bool = False,
 ) -> Result:
     if cfg:
@@ -20,10 +21,11 @@ def run_cli(
         workdir.write_database(wd, db)
 
     runner = CliRunner()
+    env = env or {}
     result = runner.invoke(
         cli,
         cmd,
-        env={"APR_WORKDIR": f"{wd.location}", "APR_DEBUG": "1"},
+        env={"APR_WORKDIR": f"{wd.location}", "APR_DEBUG": "1", **env},
         catch_exceptions=True,
     )
     if result.exception is not None:
@@ -96,3 +98,10 @@ def get_repository(
         removed=removed,
         done=done,
     )
+
+
+def env_var_token_test_config() -> config.Config:
+    credentials = config.Credentials(api_key="", ssh_key_file="test")
+    pr = config.PrTemplate()
+    cmd = ["bash", "-c", "echo 'test' > testfile.txt"]
+    return config.Config(credentials=credentials, pr=pr, update_command=cmd)