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

[DX-908]Generate url availability file #3986

Merged
merged 18 commits into from
Jan 23, 2024

Conversation

yurisasuke
Copy link
Member

@yurisasuke yurisasuke commented Jan 22, 2024

This pr contains the github action that will be run to produce the json file that will be used to create the dynamic version selector.

Copy link
Contributor

PR Analysis

  • 🎯 Main theme: The PR is about generating a file that contains the availability of URLs across different versions of the documentation.
  • 📝 PR summary: The PR introduces a Python script that fetches URLs for different versions of the documentation and determines their availability. It also includes a GitHub workflow that runs this script on pull requests to the master branch.
  • 📌 Type of PR: Enhancement
  • 🧪 Relevant tests added: No
  • ⏱️ Estimated effort to review [1-5]: 3, because the PR introduces a significant amount of new code that interacts with external resources, which requires careful review to ensure correctness and handle potential errors.
  • 🔒 Security concerns: No security concerns found

PR Feedback

💡 General suggestions: The PR is generally well-structured, but it lacks error handling in some places. It would be beneficial to add more comments to explain the purpose of certain blocks of code, especially those involving complex logic. Also, consider adding unit tests to ensure the correctness of the code.

🤖 Code feedback:
relevant filescripts/page_available_since.py
suggestion      

Consider adding error handling for the requests.get call in the fetch_file function. This will ensure that the script doesn't crash if the request fails for any reason. [important]

relevant lineresponse = requests.get(url, headers={'user-agent': 'insomnia/2023.4.0'})

relevant filescripts/page_available_since.py
suggestion      

It would be beneficial to add a main function and use the if __name__ == "__main__": idiom to allow or prevent parts of code from being run when the modules are imported. [medium]

relevant lineprocess_and_write_to_file()

relevant filescripts/page_available_since.py
suggestion      

Consider using a linter or formatter to ensure consistent code style. This will make the code easier to read and maintain. [medium]

relevant linedef process_and_write_to_file() -> None:

relevant file.github/workflows/page_available_since.yml
suggestion      

Consider adding a step in the workflow to install the necessary Python dependencies before running the script. [important]

relevant linepython3 page_available_since.py


✨ Usage guide:

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...
Utilizing extra instructions

The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project.

Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.

Examples for extra instructions:

[pr_reviewer] # /review #
extra_instructions="""
In the code feedback section, emphasize the following:
- Does the code logic cover relevant edge cases?
- Is the code logic clear and easy to understand?
- Is the code logic efficient?
...
"""

Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

How to enable\disable automation
  • When you first install PR-Agent app, the default mode for the review tool is:
pr_commands = ["/review", ...]

meaning the review tool will run automatically on every PR, with the default configuration.
Edit this field to enable/disable the tool, or to change the used configurations

About the 'Code feedback' section

The review tool provides several type of feedbacks, one of them is code suggestions.
If you are interested only in the code suggestions, it is recommended to use the improve feature instead, since it dedicated only to code suggestions, and usually gives better results.
Use the review tool if you want to get a more comprehensive feedback, which includes code suggestions as well.

Auto-labels

The review tool can auto-generate two specific types of labels for a PR:

  • a possible security issue label, that detects possible security issues (enable_review_labels_security flag)
  • a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)
Extra sub-tools

The review tool provides a collection of possible feedbacks about a PR.
It is recommended to review the possible options, and choose the ones relevant for your use case.
Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example:
require_score_review, require_soc2_review, enable_review_labels_effort, and more.

More PR-Agent commands

To invoke the PR-Agent, add a comment using one of the following commands:

  • /review: Request a review of your Pull Request.
  • /describe: Update the PR title and description based on the contents of the PR.
  • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
  • /ask <QUESTION>: Ask a question about the PR.
  • /update_changelog: Update the changelog based on the PR's contents.
  • /add_docs 💎: Generate docstring for new components introduced in the PR.
  • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
  • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

See the tools guide for more details.
To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

@yurisasuke yurisasuke changed the title Generate url availability file [DX-908]Generate url availability file Jan 22, 2024
Copy link
Contributor

@dcs3spp dcs3spp left a comment

Choose a reason for hiding this comment

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

PR LGTM and approving. As discussed in meet add comments for block of codes that stores similar and diff paths.

Copy link

netlify bot commented Jan 23, 2024

PS. Pls add /docs/nightly to the end of url

Name Link
🔨 Latest commit 54bb94b
🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/65afa4ad3c06d30008e7a386
😎 Deploy Preview https://deploy-preview-3986--tyk-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance:
Accessibility:
Best Practices:
SEO:
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Jan 23, 2024

PS. Pls add /docs/nightly to the end of url

Name Link
🔨 Latest commit 52e9823
🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/65afa657c4979a0008c83ca7
😎 Deploy Preview https://deploy-preview-3986--tyk-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance:
Accessibility:
Best Practices:
SEO:
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@yurisasuke yurisasuke merged commit d9b8fdc into master Jan 23, 2024
10 checks passed
@yurisasuke yurisasuke deleted the generate-url-availability-file branch January 23, 2024 11:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants