Skip to content
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

fix(cruft): change GH update token #12

Merged
merged 2 commits into from
Aug 30, 2024
Merged

fix(cruft): change GH update token #12

merged 2 commits into from
Aug 30, 2024

Conversation

JaeAeich
Copy link
Collaborator

@JaeAeich JaeAeich commented Aug 6, 2024

Description

Checklist

  • My code follows the contributing guidelines of this
    project, including, in particular, with regard to any style guidelines
  • The title of my PR complies with the Conventional Commits
    specification
    ; in particular, it clearly indicates
    that a change is a breaking change
  • I acknowledge that all my commits will be squashed into a single commit,
    using the PR title as the commit message
  • I have performed a self-review of my own code
  • I have commented my code in hard-to-understand areas
  • I have updated the user-facing documentation to describe any new or
    changed behavior
  • I have added type annotations for all function/class/method interfaces
    or updated existing ones (only for Python, TypeScript, etc.)
  • I have provided appropriate documentation (Google-style Python
    docstrings
    ) for all packages/modules/functions/classes/
    methods or updated existing ones
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature
    works
  • New and existing unit tests pass locally with my changes
  • I have not reduced the existing code coverage

Comments

Summary by Sourcery

Fix the GitHub token name in the update workflow and README. Refactor test fixtures to standard test functions in integration and unit tests.

Bug Fixes:

  • Fix the GitHub token name in the update workflow to use the correct token.

Enhancements:

  • Refactor test fixtures to standard test functions in integration and unit tests.

Documentation:

  • Update README to reflect the correct GitHub token name.

Copy link

sourcery-ai bot commented Aug 6, 2024

Reviewer's Guide by Sourcery

This pull request addresses issue #11 by updating the GitHub token references in the documentation and GitHub Actions workflow. Additionally, it refactors test functions in the integration and unit test files by removing pytest fixture decorators and renaming the functions for better clarity.

File-Level Changes

Files Changes
{{ cookiecutter.project_name }}/tests/test_integration/test_init.py
{{ cookiecutter.project_name }}/tests/test_unit/test_init.py
Refactored test functions by removing pytest fixture decorators and renaming the functions for better clarity.
README.md
{{ cookiecutter.project_name }}/.github/workflows/update.yaml
Updated GitHub token references from AUTO_UPDATE_GITHUB_TOKEN to GITHUB_TOKEN in both documentation and GitHub Actions workflow.

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

@JaeAeich JaeAeich requested a review from uniqueg August 6, 2024 08:20
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @JaeAeich - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Please ensure that the removal of the pytest import in the test files doesn't affect any other parts of the tests that might still require it.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

@JaeAeich
Copy link
Collaborator Author

JaeAeich commented Aug 6, 2024

@uniqueg I am not sure about this but changed the token, for if we need we can merge it first.

AAH I see tus_handlers PR has already been merged. Leave it!! Then we can take care of this later. Close the PR please if this isn;t what you meant.

@JaeAeich
Copy link
Collaborator Author

JaeAeich commented Aug 6, 2024

how about we make changes to the repo this week, and you can just create a copy of the token (GITHUB_TOKEN) and add it to the org, if we get a PR on moday, all good and we can go ahead with this or else checkout whats wrong.

@uniqueg uniqueg changed the title fix(cruft): change gh update token fix(cruft): change GH update token Aug 6, 2024
@JaeAeich JaeAeich requested a review from uniqueg August 30, 2024 14:09
@JaeAeich
Copy link
Collaborator Author

@uniqueg maybe merge #15 before this :)

@JaeAeich
Copy link
Collaborator Author

merging this first, will add one more commit for the typo to #15 and merge after this.

@JaeAeich JaeAeich merged commit 1254e1b into main Aug 30, 2024
@JaeAeich JaeAeich deleted the update branch August 30, 2024 15:51
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.

fix(ci): github token for update
2 participants