Adding `prevent_self_review` property to `Repository.createEnvironment` #3246

gopidesupavan · 2025-02-24T23:06:12Z

Currently create environment api supports prevent_self_review, adding missing property to support in PyGithub.

https://docs.github.com/en/rest/deployments/environments?apiVersion=2022-11-28#create-or-update-an-environment

as per response from the endpoint looks like this, prevent_self_review falls under protection_rules, updated accordingly to the EnvironmentProtectionRule

{
    "id": 5687891617,
    "node_id": "EN_kwDON9Ex-M8AAAABUwZWoQ",
    "name": "test_two",
    "url": "https://api.github.com/repos/gopidesupavan/test-dependaboat-configs/environments/test_two",
    "html_url": "https://github.com/gopidesupavan/test-dependaboat-configs/deployments/activity_log?environments_filter=test_two",
    "created_at": "2025-02-24T20:40:56Z",
    "updated_at": "2025-02-24T20:40:56Z",
    "can_admins_bypass": true,
    "protection_rules": [
        {
            "id": 29234176,
            "node_id": "GA_kwDON9Ex-M4BvhQA",
            "type": "required_reviewers",
            "prevent_self_review": true,
            "reviewers": [
                {
                    "type": "User",
                    "reviewer": {
                        "login": "gopidesupavan",
                        "id": 31437079,
                        "node_id": "MDQ6VXNlcjMxNDM3MDc5",
                        "avatar_url": "https://avatars.githubusercontent.com/u/31437079?v=4",
                        "gravatar_id": "",
                        "url": "https://api.github.com/users/gopidesupavan",
                        "html_url": "https://github.com/gopidesupavan",
                        "followers_url": "https://api.github.com/users/gopidesupavan/followers",
                        "following_url": "https://api.github.com/users/gopidesupavan/following{/other_user}",
                        "gists_url": "https://api.github.com/users/gopidesupavan/gists{/gist_id}",
                        "starred_url": "https://api.github.com/users/gopidesupavan/starred{/owner}{/repo}",
                        "subscriptions_url": "https://api.github.com/users/gopidesupavan/subscriptions",
                        "organizations_url": "https://api.github.com/users/gopidesupavan/orgs",
                        "repos_url": "https://api.github.com/users/gopidesupavan/repos",
                        "events_url": "https://api.github.com/users/gopidesupavan/events{/privacy}",
                        "received_events_url": "https://api.github.com/users/gopidesupavan/received_events",
                        "type": "User",
                        "user_view_type": "public",
                        "site_admin": false
                    }
                }
            ]
        },
        {
            "id": 29234177,
            "node_id": "GA_kwDON9Ex-M4BvhQB",
            "type": "wait_timer",
            "wait_timer": 5
        },
        {
            "id": 29234187,
            "node_id": "GA_kwDON9Ex-M4BvhQL",
            "type": "branch_policy"
        }
    ],
    "deployment_branch_policy": {
        "protected_branches": false,
        "custom_branch_policies": true
    }
}

gopidesupavan · 2025-02-24T23:09:16Z

cc: @potiuk @netomi

netomi · 2025-02-25T06:59:10Z

LGTM

potiuk · 2025-02-28T20:44:50Z

would be cool to merge it in :)

gopidesupavan · 2025-03-14T11:30:07Z

@EnricoMi would love get some review this one, please help us? or could you direct who can be best person to review this change.

At The Apache Software Foundation we are working on some setups for github actions for Trusted releases, would love to use pytgithub creating deployment environments. this feature is required. I really appreciate your help here.

potiuk · 2025-03-14T11:46:56Z

Yes. It would be really useful to get it in the release

EnricoMi

LGTM!

github-actions · 2025-03-17T08:58:38Z

Test Results

7 files ±0 7 suites ±0 4m 13s ⏱️ -10s
997 tests ±0 997 ✅ ±0 0 💤 ±0 0 ❌ ±0
6 979 runs ±0 6 978 ✅ ±0 1 💤 ±0 0 ❌ ±0

Results for commit a46460a. ± Comparison against base commit 8aa27d4.

gopidesupavan · 2025-03-17T23:13:49Z

LGTM!

Thank you @EnricoMi :)

…t` (PyGithub#3246) Currently create environment api supports `prevent_self_review`, adding missing property to support in PyGithub. https://docs.github.com/en/rest/deployments/environments?apiVersion=2022-11-28#create-or-update-an-environment as per response from the endpoint looks like this, `prevent_self_review` falls under protection_rules, updated accordingly to the `EnvironmentProtectionRule` ``` { "id": 5687891617, "node_id": "EN_kwDON9Ex-M8AAAABUwZWoQ", "name": "test_two", "url": "https://api.github.com/repos/gopidesupavan/test-dependaboat-configs/environments/test_two", "html_url": "https://github.com/gopidesupavan/test-dependaboat-configs/deployments/activity_log?environments_filter=test_two", "created_at": "2025-02-24T20:40:56Z", "updated_at": "2025-02-24T20:40:56Z", "can_admins_bypass": true, "protection_rules": [ { "id": 29234176, "node_id": "GA_kwDON9Ex-M4BvhQA", "type": "required_reviewers", "prevent_self_review": true, "reviewers": [ { "type": "User", "reviewer": { "login": "gopidesupavan", "id": 31437079, "node_id": "MDQ6VXNlcjMxNDM3MDc5", "avatar_url": "https://avatars.githubusercontent.com/u/31437079?v=4", "gravatar_id": "", "url": "https://api.github.com/users/gopidesupavan", "html_url": "https://github.com/gopidesupavan", "followers_url": "https://api.github.com/users/gopidesupavan/followers", "following_url": "https://api.github.com/users/gopidesupavan/following{/other_user}", "gists_url": "https://api.github.com/users/gopidesupavan/gists{/gist_id}", "starred_url": "https://api.github.com/users/gopidesupavan/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/gopidesupavan/subscriptions", "organizations_url": "https://api.github.com/users/gopidesupavan/orgs", "repos_url": "https://api.github.com/users/gopidesupavan/repos", "events_url": "https://api.github.com/users/gopidesupavan/events{/privacy}", "received_events_url": "https://api.github.com/users/gopidesupavan/received_events", "type": "User", "user_view_type": "public", "site_admin": false } } ] }, { "id": 29234177, "node_id": "GA_kwDON9Ex-M4BvhQB", "type": "wait_timer", "wait_timer": 5 }, { "id": 29234187, "node_id": "GA_kwDON9Ex-M4BvhQL", "type": "branch_policy" } ], "deployment_branch_policy": { "protected_branches": false, "custom_branch_policies": true } } ```

Adding prevent_self_review property support to create_environment

d6a96bf

remove duplicate asserts for prevent_self_review

a46460a

gopidesupavan mentioned this pull request Feb 28, 2025

Support for deployment environments apache/infrastructure-asfyaml#21

Merged

EnricoMi changed the title ~~Adding prevent_self_review property support to create_environment~~ Adding prevent_self_review property to Repository.createEnvironemnt Mar 17, 2025

EnricoMi changed the title ~~Adding prevent_self_review property to Repository.createEnvironemnt~~ Adding prevent_self_review property to Repository.createEnvironment Mar 17, 2025

EnricoMi approved these changes Mar 17, 2025

View reviewed changes

EnricoMi added the improvement label Mar 17, 2025

EnricoMi added this pull request to the merge queue Jul 30, 2025

Merged via the queue into PyGithub:main with commit e2a05ff Jul 30, 2025
15 checks passed

EnricoMi mentioned this pull request Jul 30, 2025

Add prevent_self_review to creating environments #3312

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Adding `prevent_self_review` property to `Repository.createEnvironment` #3246

Adding `prevent_self_review` property to `Repository.createEnvironment` #3246

Uh oh!

gopidesupavan commented Feb 24, 2025

Uh oh!

gopidesupavan commented Feb 24, 2025

Uh oh!

netomi commented Feb 25, 2025

Uh oh!

potiuk commented Feb 28, 2025

Uh oh!

gopidesupavan commented Mar 14, 2025

Uh oh!

potiuk commented Mar 14, 2025

Uh oh!

EnricoMi left a comment

Uh oh!

github-actions bot commented Mar 17, 2025

Uh oh!

gopidesupavan commented Mar 17, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Adding prevent_self_review property to Repository.createEnvironment #3246

Adding prevent_self_review property to Repository.createEnvironment #3246

Uh oh!

Conversation

gopidesupavan commented Feb 24, 2025

Uh oh!

gopidesupavan commented Feb 24, 2025

Uh oh!

netomi commented Feb 25, 2025

Uh oh!

potiuk commented Feb 28, 2025

Uh oh!

gopidesupavan commented Mar 14, 2025

Uh oh!

potiuk commented Mar 14, 2025

Uh oh!

EnricoMi left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 17, 2025

Test Results

Uh oh!

gopidesupavan commented Mar 17, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Adding `prevent_self_review` property to `Repository.createEnvironment` #3246

Adding `prevent_self_review` property to `Repository.createEnvironment` #3246