feat: add issue URL support to CreatePR step

[devin-ai-integration]

Add issue URL support to CreatePR step to enable linking PRs to GitHub issues.

Changes:

• Added optional 'issue_url' parameter to CreatePR step
• Added functionality to extract issue number from GitHub issue URL
• Added 'Resolves #' to PR description when issue URL is provided
• Updated documentation to clarify that this works for both PR and PRPB steps (since PRPB is an alias for PR)

This change enables automatic issue linking when creating pull requests through either the PR or PRPB step (they use the same underlying implementation).

Link to Devin run: https://app.devin.ai/sessions/3fa48606a6fa43548d0a59f6c8706610

[devin-ai-integration]

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

• Address comments on this PR
• Look at CI failures and help fix them

⚙️ Control Options:

• Disable automatic comment and CI monitoring

Add "(aside)" to your comment to have me ignore it.

[CLAassistant]

All committers have signed the CLA.

[devin-ai-integration]

I have read the CLA Document and I hereby sign the CLA

[patched-admin]

The pull request review identifies several areas of concern related to potential bugs, security vulnerabilities, and adherence to coding standards. It points out a potential bug where the handling of None returns from scm_client.get_slug_and_id_from_url(issue_url) is not adequately addressed, which could lead to crashes. Moreover, the review notes a lack of input checks for issue_url, raising security concerns about possible injection attacks if the URL originates from untrusted sources. Regarding coding standards, while the code mostly adheres to existing style conventions, there is a suggestion to avoid redundant comments and maintain consistency when using optional types across the codebase. Despite these issues, the documentation update is praised for clearly reflecting the new functionality to link a PR to a GitHub issue and aligns with current documentation practices, introducing no new bugs or security vulnerabilities. The review advises ensuring that all interactions consider scenarios where issue_url is None and that API keys are securely managed to avert potential exposure or logging.

---

• File changed: patchwork/steps/CreatePR/CreatePR.py
  1. Potential Bugs:
  • The current implementation does not handle the scenario where scm_client.get_slug_and_id_from_url(issue_url) returns None due to an invalid URL or issues with parsing. This could lead to unexpected behavior or crashes when the issue info is not successfully retrieved.

2. Security Vulnerabilities:

   • The code references and manipulates issue_url, but there are no apparent checks or sanitizations for this input. If issue_url comes from an untrusted source, there could be risks of security vulnerabilities such as injection attacks depending on how the URL is processed within other parts of the system.

3. Coding Standards Adherence:

   • The added code seems to follow the existing code style conventions regarding variable naming and organization. However, the comment # Optional GitHub Issue URL to link the PR to is reused at two places. Consider maintaining consistency by keeping it concise or more context-specific if needed.
   • The addition of final_body to handle appending the issue_number seems appropriate, but ensure this convention is used consistently across such implementations if it's a common feature.

• File changed: patchwork/steps/CreatePR/README.md
  The modifications in the pull request update the documentation to include an optional issue_url input, which adds functionality to link a PR to a GitHub issue.

• Coding Standards: The addition appears consistent with existing documentation style and standards.

• Potential Bugs: There do not appear to be any direct code changes, as this is a documentation update, so no potential bugs introduced here.

• Security Vulnerabilities: As this is purely a documentation update, no new security vulnerabilities would be introduced solely by this change.

Overall, the PR accurately reflects a new input capability to link GitHub issues and maintains alignment with current documentation practices.

• File changed: patchwork/steps/CreatePR/typed.py
  1. Potential Bugs: Introducing the issue_url as an Optional type poses a potential bug if other parts of the codebase do not handle cases where issue_url is None. Ensure all interactions with issue_url are validated for None values to prevent AttributeError or similar exceptions.

2. Security Vulnerabilities: Since the code deals with API keys (gitlab_api_key, github_api_key, azuredevops_api_key), it's crucial to ensure they are stored securely and never logged or exposed inadvertently. This section of the code does not present sufficient information regarding handling these keys, so verify if any part of the application logs or mishandles API keys.

3. Coding Standards: The modification adheres to the original coding style by using Annotated and Optional types correctly from Python's typing modules. However, ensure consistency in using Optional where necessary across the codebase when introducing optional fields.

[CTY-git]

This is only applicable for github repos. Perhaps check the scm_client's type first before performing this.