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.

Sign up for GitHub

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

DQ-420 docs: modify readme #9

Merged
merged 2 commits into from
Oct 8, 2024
Merged

DQ-420 docs: modify readme #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d672ec
docs: modify readme
rittikdasgupta Oct 8, 2024
5bd773d
npm: run build
rittikdasgupta Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Here's what it looks like 👇

## Configure the action

1. Create [repository secrets](https://github.com/Azure/actions-workflow-samples/blob/master/assets/create-secrets-for-GitHub-workflows.md#creating-secrets) in your repository:
1. Create [repository secrets](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions) in your repository:

- `ATLAN_INSTANCE_URL` with the URL of your Atlan instance.
- `ATLAN_API_TOKEN` with the value of the API token.
Expand All @@ -27,7 +27,7 @@ Here's what it looks like 👇

2. Add the GitHub Action to your workflow:

1. Create a workflow file in your repository: `.github/workflows/atlan-dbt.yml`
1. Create a workflow file in your repository: `.github/workflows/atlan-impact-analysis.yml`
2. Add the following code to the workflow file:

```yaml
Expand Down Expand Up @@ -55,11 +55,11 @@ Here's what it looks like 👇
ATLAN_CONFIG: .atlan/config.yaml
```

## Test the action
## Running the Action

After you've completed the configuration above, create a pull request with a changed dbt model or data contract file to test the action. You should see the Atlan GitHub action running and then adding comments in your pull request:
After you've completed the configuration above, create a pull request with a changed dbt model or data contract file to run the action. You should see the Atlan action running and then adding comments in your pull request:

- The GitHub workflow will add and update a single comment for every file change.
- The action will add and update a single comment for every file change.
- The impacted assets in the comment will be displayed in a collapsible section and grouped by source and asset type.
- The comment will include some metadata for your impacted assets — such as descriptions, owners, and linked glossary terms.
- View the impacted assets in Atlan or open the source URL — for example, view an impacted Looker dashboard directly in Looker.
Expand Down
Loading