Skip to content

Allow users to specify custom tokens #5

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 6 commits into from
Oct 21, 2024
Merged

Conversation

CompeyDev
Copy link
Contributor

@CompeyDev CompeyDev commented Oct 21, 2024

This allows the user to specify their token using a token input, defaulting to the regular ${{ github.token }} if not.

Summary by Sourcery

New Features:

  • Introduce a new input parameter 'token' to allow users to specify a custom GitHub token for API and git access.

Copy link

sourcery-ai bot commented Oct 21, 2024

Reviewer's Guide by Sourcery

This pull request introduces a new input parameter 'token' to allow users to specify a custom GitHub token for authentication, with a default value of ${{ github.token }}. The action now uses this custom token for GitHub CLI authentication instead of the hardcoded github.token.

User journey diagram for specifying custom tokens

journey
    title User journey for specifying custom tokens
    section Token Specification
      User: Specify custom token: 5: User
      System: Use specified token for authentication: 5: System
      System: Default to ${{ github.token }} if not specified: 3: System
    section Authentication
      System: Authenticate using specified token: 5: System
      System: Authenticate using default token if custom not provided: 3: System
Loading

File-Level Changes

Change Details Files
Add a new input parameter for custom GitHub token
  • Introduce a new 'token' input in the action.yml file
  • Set the default value of the token to ${{ github.token }}
  • Make the token input optional
action.yml
Update GitHub CLI authentication to use the custom token
  • Replace hardcoded ${{ github.token }} with ${{ inputs.token }} in the authentication step
action.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

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 @CompeyDev - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a brief comment or documentation about when and why a user might want to use a custom token, and any security considerations they should be aware of when using this feature.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟡 Security: 1 issue found
  • 🟢 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 and I'll use the feedback to improve your reviews.

@imba-tjd imba-tjd merged commit 696d229 into imba-tjd:master Oct 21, 2024
@imba-tjd
Copy link
Owner

Thank you!

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