Skip to content

fixes production / staging URLs - #955

Merged
DilwoarH merged 1 commit into
mainfrom
fix-production-urls
Mar 12, 2025
Merged

fixes production / staging URLs#955
DilwoarH merged 1 commit into
mainfrom
fix-production-urls

Conversation

@DilwoarH

@DilwoarH DilwoarH commented Mar 12, 2025

Copy link
Copy Markdown
Contributor

Preview Link

https://submit-pr-[PR_NUMBER].herokuapp.com/

What type of PR is this? (check all applicable)

  • Refactor
  • Feature
  • Bug Fix
  • Optimization
  • Documentation Update

Description

Please replace this line with a brief description of the changes made.

Related Tickets & Documents

  • Ticket Link
  • Related Issue #
  • Closes #

QA Instructions, Screenshots, Recordings

Before

Before screenshot here

After

After screenshot here

Added/updated tests?

We encourage you to keep the code coverage percentage at 80% and above.

  • Yes
  • No, and this is why: Please replace this line with details on why tests have not been included
  • I need help with writing tests

QA sign off

  • Code has been checked and approved
  • Design has been checked and approved
  • Product and business logic has been checked and proved

[optional] Are there any post-deployment tasks we need to perform?

[optional] Are there any dependencies on other PRs or Work?

Summary by CodeRabbit

  • Chores
    • Updated the endpoints for asynchronous operations in both production and staging environments.
  • Documentation
    • Improved local development setup instructions by adding a link for generating API keys for Jira integration.

@coderabbitai

coderabbitai Bot commented Mar 12, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

The pull request updates the URL endpoints in both the production and staging configuration files by replacing the old API URLs with new ones for asynchronous requests. Additionally, it amends the README to include a link for generating API keys under the Jira Integration section. These modifications adjust the application's connectivity settings and enhance the documentation without affecting other configurations.

Changes

File(s) Change Summary
config/production.yaml
config/staging.yaml
Updated the url field in the asyncRequestApi section. In production, the URL was changed from https://publish.digital-land.info/ to https://submit.planning.data.gov.uk/; in staging, it was updated from https://publish.staging.digital-land.info/ to https://submit.staging.planning.data.gov.uk/.
readme.md Added a new line under the "Jira Integration (for local development)" section to include a link for generating API keys.

Suggested reviewers

  • rosado

Poem

I'm a little rabbit in a field of code,
Hopping through configs on my winding road.
Old URLs were out, new ones in sight,
Guiding async requests with fresh light.
Celebrate with a hop and a cheerful byte!


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@eveleighoj
eveleighoj temporarily deployed to submit-pr-955 March 12, 2025 10:05 Inactive
@github-actions

Copy link
Copy Markdown

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 67.43% 5613 / 8323
🔵 Statements 67.43% 5613 / 8323
🔵 Functions 63.78% 236 / 370
🔵 Branches 79.63% 735 / 923
File CoverageNo changed files found.
Generated in workflow #947 for commit 1f71b42 by the Vitest Coverage Report Action

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
readme.md (1)

152-153: Enhance documentation clarity in the Jira Integration section.

The newly added link for generating API keys is a useful addition that assists users with Jira authentication. It would be beneficial to include a short note explaining when and why to use this link, to provide extra context and improve user guidance.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4d3be47 and 1f71b42.

📒 Files selected for processing (3)
  • config/production.yaml (1 hunks)
  • config/staging.yaml (1 hunks)
  • readme.md (1 hunks)
🔇 Additional comments (2)
config/staging.yaml (1)

13-13: Update Staging URL Endpoint.

The staging URL has been updated to https://submit.staging.planning.data.gov.uk/, which aligns with the new endpoint conventions. Please verify that this new endpoint fulfils all integration requirements and that any related environment variables or settings expect this format.

config/production.yaml (1)

13-14:

Details

❓ Verification inconclusive

Review Production URL Configuration Scope.

The production configuration now includes a new top-level url key set to https://submit.planning.data.gov.uk/. However, the asyncRequestApi block still retains its original URL. Please confirm whether the intention is to override the asynchronous API endpoint by introducing a separate top-level URL, or if the update should be applied directly within the asyncRequestApi block to avoid potential confusion.


Production URL Configuration Clarification

The production configuration now sets a new top-level url key (https://submit.planning.data.gov.uk/), yet the asyncRequestApi block still specifies its original URL. Could you please confirm whether this is intentional—i.e. maintaining separate endpoints—or if the asynchronous API’s URL should also be updated to reflect the new production endpoint? This clarification will help avoid any potential confusion in the configuration.

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.

3 participants