Skip to content

Configure dependabot to ignore 'idna' #1259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 14, 2021

Conversation

lukpueh
Copy link
Member

@lukpueh lukpueh commented Jan 11, 2021

Fixes -
Related to #1256

Description of the changes being introduced by the pull request:
New releases of the transitive (via 'requests') dependency 'idna' break Python 2.7 builds. To fix this we configure dependabot to not bump 'idna' in requirements-pinned.txt, which lists and auto-updates all immediate and transitive dependencies for CI/CD testing.

An alternative would be to add and restrict 'idna' in 'requirements.txt' but this is less preferable because 'requirements.txt' should only have direct dependencies.

Please verify and check that the pull request fulfills the following
requirements
:

  • The code follows the Code Style Guidelines
  • Tests have been added for the bug fix or new feature
  • Docs have been added for the bug fix or new feature

@@ -6,3 +6,8 @@ updates:
interval: daily
time: "10:00"
open-pull-requests-limit: 10
ignore:
Copy link
Member

Choose a reason for hiding this comment

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

The docs you linked to earlier suggest this should be ignored_updates? Did this change when Dependabot was integrated into GitHub?

Copy link
Member Author

Choose a reason for hiding this comment

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

Did this change when Dependabot was integrated into GitHub?

Exactly. I used the "Dependabot Preview" (legacy non-native version) web interface to PR the initial dependabot.yml (#1258), which also did the migration to GitHub-native, which seems to have a slightly different config syntax: https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/enabling-and-disabling-version-updates#disabling-dependabot-version-updates

# New 'idna' (see 'requests') releases break Python 2.7 builds. Ignore here
# to avoid listing/pinning transitive dependencies in requirements.txt.
# FIXME: Un-ignore when dropping Python 2.7 or resolving #1249
- dependency-name: "idna"
Copy link
Member

Choose a reason for hiding this comment

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

Nit:

Suggested change
- dependency-name: "idna"
- dependency-name: "idna"

@lukpueh
Copy link
Member Author

lukpueh commented Jan 12, 2021

Thanks for the quick review, @joshuagl! Just force-pushed an updated commit that adds the newline and the relevant docs in the commit message.

New releases of the transitive (via 'requests') dependency 'idna'
break Python 2.7 builds. To fix this we configure dependabot to not
bump 'idna' in requirements-pinned.txt, which lists and
auto-updates all immediate and transitive dependencies for CI/CD
testing.

An alternative would be to add and restrict 'idna' in
'requirements.txt' but this is less preferable because
'requirements.txt' should only have direct dependencies.

For consulted dependabot config docs see:
https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/enabling-and-disabling-version-updates#disabling-dependabot-version-updates

Signed-off-by: Lukas Puehringer <[email protected]>
@lukpueh
Copy link
Member Author

lukpueh commented Jan 12, 2021

Just force-pushed an updated commit that adds the newline and the relevant docs in the commit message.

Sorry, forgot to stage the change. 🤦 Now the newline is indeed included.

Copy link
Member

@joshuagl joshuagl left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @lukpueh !

@joshuagl joshuagl merged commit d524412 into theupdateframework:develop Jan 14, 2021
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