Skip to content

Conversation

@anshbansal
Copy link
Collaborator

fixes broken build https://github.com/datahub-project/datahub/actions/runs/3884089588/jobs/6626190025

$ rm -rf docs && mkdir docs && yarn _generate-graphql && ts-node -O '{ "lib": ["es2020"], "target": "es6" }' generateDocsDir.ts
$ mkdir -p genDocs && docusaurus docs:generate:graphql

/home/runner/work/datahub/datahub/docs-website/generateDocsDir.ts:5
import { Octokit } from "@octokit/rest";
                                                         ^
Error: File not accounted for in sidebar: docs/rfc/active/5818-serial-updates.md - try adding it to docs-website/sidebars.js
    at /home/runner/work/datahub/datahub/docs-website/generateDocsDir.ts:574:13
    at Generator.next (<anonymous>)
    at fulfilled (/home/runner/work/datahub/datahub/docs-website/generateDocsDir.ts:5:58)
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
error Command failed with exit code 1.

FAILURE: Build failed with an exception.

fixes broken snowflake docs. build isn't working on my M1 so this is my guess that newlines are causing build to break. This is not tested.
image

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

@github-actions github-actions bot added the ingestion PR or Issue related to the ingestion of metadata label Jan 10, 2023
@anshbansal anshbansal requested a review from jjoyce0510 January 10, 2023 15:39
@anshbansal anshbansal added the docs Issues and Improvements to docs label Jan 10, 2023
`without_lineage` only extracts tags that have been applied directly to the given entity.
`with_lineage` extracts both directly applied and propagated tags, but will be significantly slower.
See the [Snowflake documentation](https://docs.snowflake.com/en/user-guide/object-tagging.html#tag-lineage) for information about tag lineage/propagation. """,
description="""Optional. Allowed values are `without_lineage`, `with_lineage`, and `skip` (default). `without_lineage` only extracts tags that have been applied directly to the given entity. `with_lineage` extracts both directly applied and propagated tags, but will be significantly slower. See the [Snowflake documentation](https://docs.snowflake.com/en/user-guide/object-tagging.html#tag-lineage) for information about tag lineage/propagation. """,
Copy link
Collaborator

Choose a reason for hiding this comment

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

Thanks for fixing this. I think will be the solve.

Copy link
Collaborator

@jjoyce0510 jjoyce0510 left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you

@jjoyce0510
Copy link
Collaborator

We can merge after documentation builds.

@anshbansal anshbansal merged commit c82d4fb into master Jan 10, 2023
@anshbansal anshbansal deleted the aseem-fix-doc-build branch January 10, 2023 17:22
ericyomi pushed a commit to ericyomi/datahub that referenced this pull request Jan 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Issues and Improvements to docs ingestion PR or Issue related to the ingestion of metadata

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants