Skip to content

Validate HTTP links in the source code #78273

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

Open
jakelandis opened this issue Sep 23, 2021 · 2 comments
Open

Validate HTTP links in the source code #78273

jakelandis opened this issue Sep 23, 2021 · 2 comments
Labels
:Delivery/Build Build or test infrastructure >enhancement Team:Delivery Meta label for Delivery team

Comments

@jakelandis
Copy link
Contributor

jakelandis commented Sep 23, 2021

The deprecation info API is used during upgrades to help users better understand the changes that are necessary before they upgrade. To help present this information each entry exposes an HTTP link for additional documentation. These HTTP links are embedded in the source code and like all remote links have the potential to be broken.

We recently switched to using shortened links which will allow us to better mitigate any broken links. However, we should also include some CI validation that these links are still good.

Ideally, with both shortened URLs and validation we could also consider opening the door to allow exceptions, deprecation logs, server logs, etc. to also embed HTTP links if it makes sense.

I assume we would need to :

  1. externalize all of the HTTP links to a resource file
  2. create a gradle task that can validate the response code and possibly an expected regex
  3. wire that check into CI.
@jakelandis jakelandis added >enhancement :Delivery/Build Build or test infrastructure :Core/Infra/Core Core issues without another label labels Sep 23, 2021
@elasticmachine elasticmachine added Team:Core/Infra Meta label for core/infra team Team:Delivery Meta label for Delivery team labels Sep 23, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-infra (Team:Core/Infra)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-delivery (Team:Delivery)

@rdnm rdnm removed :Core/Infra/Core Core issues without another label Team:Core/Infra Meta label for core/infra team labels Oct 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Delivery/Build Build or test infrastructure >enhancement Team:Delivery Meta label for Delivery team
Projects
None yet
Development

No branches or pull requests

3 participants