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

Validate links in frontend in CI #13600

Merged
merged 6 commits into from
Jun 8, 2022
Merged

Validate links in frontend in CI #13600

merged 6 commits into from
Jun 8, 2022

Conversation

timroes
Copy link
Collaborator

@timroes timroes commented Jun 8, 2022

What

Closes #12694

This PR adds automated validation for all links used in the frontend. We should make sure they are all part of the links.ts file (I renamed this from uiConfig.ts.

This check will run as part of the regular CI build run now. Also in addition there is a scheduled daily check that will post notifications to #dev-frontend if the run fails.

This also changes the variable name from config.ui.<link name> to the more meaningful config.links.

@github-actions github-actions bot added area/platform issues related to the platform area/frontend Related to the Airbyte webapp labels Jun 8, 2022
@timroes timroes temporarily deployed to more-secrets June 8, 2022 11:53 Inactive
@timroes timroes marked this pull request as ready for review June 8, 2022 12:27
@timroes timroes requested a review from a team as a code owner June 8, 2022 12:27
@timroes timroes requested a review from davinchia June 8, 2022 12:27
@timroes timroes temporarily deployed to more-secrets June 8, 2022 12:29 Inactive
Copy link
Contributor

@edmundito edmundito left a comment

Choose a reason for hiding this comment

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

Great! I just had one minor comment and a couple of questions, but otherwise approved

@@ -0,0 +1,6 @@
{
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this file add intended?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Absolutely not... I accidentally executed npm i inside the root directory and apparently missed this. Will remove.

airbyte-webapp/scripts/validate-links.ts Show resolved Hide resolved
@@ -1,7 +1,7 @@
import { SegmentAnalytics } from "core/analytics/types";
import { Feature } from "hooks/services/Feature";

import { UiConfig } from "./uiConfig";
import { OutboundLinks } from "./links";
Copy link
Contributor

Choose a reason for hiding this comment

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

Good rename

on:
workflow_dispatch:
schedule:
- cron: '0 14 * * *'
Copy link
Contributor

Choose a reason for hiding this comment

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

So not necessarily tied to a merge but just periodically check?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This workflow will just periodically check, but I also added it to the build, via the gradle build file inside the airbyte-webapp folder, so that any assemble/build of the gradle project will check it as well. Thus it would be part of our regular Frontend: Build runs. Since some breakage we've seen in the past though came from changes in the docs, I wanted an additional scheduled check.

@timroes timroes temporarily deployed to more-secrets June 8, 2022 13:10 Inactive
@timroes timroes merged commit 4c97893 into master Jun 8, 2022
@timroes timroes deleted the tim/validate-doc-links branch June 8, 2022 13:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/frontend Related to the Airbyte webapp area/platform issues related to the platform
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Validate all documentation links in the webapp in CI
2 participants