Skip to content

Commit 8a1b8bd

Browse files
rename(repo): change dbt-action to atlan-action
1 parent 7f07f7e commit 8a1b8bd

File tree

8 files changed

+40
-30
lines changed

8 files changed

+40
-30
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Atlan dbt Action
1+
# Atlan Action
22

33
![atlan<>dbt](https://user-images.githubusercontent.com/14099191/209542321-54d5557e-8abf-4d9a-9f6d-dcacb856f25f.png)
44

55
## Overview
66

7-
_Have you ever changed a dbt model only to later find it broke a downstream table or dashboard? 💔_
7+
_Have you ever changed a dbt model or a data contract only to later find it broke a downstream table or dashboard? 💔_
88

99
We've created a GitHub Action to help you out — putting Atlan's impact analysis right into your pull request. So now, before merging the PR, you can see the potential downstream impact of your changes.
1010

@@ -31,7 +31,7 @@ Here's what it looks like 👇
3131
2. Add the following code to the workflow file:
3232

3333
```yaml
34-
name: Atlan dbt action
34+
name: Atlan action
3535

3636
on:
3737
pull_request:
@@ -43,7 +43,7 @@ Here's what it looks like 👇
4343
runs-on: ubuntu-latest
4444
steps:
4545
- name: Run Action
46-
uses: atlanhq/dbt-action@v1
46+
uses: atlanhq/atlan-action@v2
4747
with:
4848
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
4949
ATLAN_INSTANCE_URL: ${{secrets.ATLAN_INSTANCE_URL}}
@@ -52,7 +52,7 @@ Here's what it looks like 👇
5252
5353
## Test the action
5454
55-
After you've completed the configuration above, create a pull request with a changed dbt model file to test the action. You should see the Atlan GitHub action running and then adding comments in your pull request:
55+
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:
5656
5757
- The GitHub workflow will add and update a single comment for every file change.
5858
- The impacted assets in the comment will be displayed in a collapsible section and grouped by source and asset type.
@@ -84,7 +84,7 @@ jobs:
8484
runs-on: ubuntu-latest
8585
steps:
8686
- name: Run Action
87-
uses: atlanhq/dbt-action@v1
87+
uses: atlanhq/atlan-action@v2
8888
with:
8989
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
9090
ATLAN_INSTANCE_URL: ${{secrets.ATLAN_INSTANCE_URL}}
@@ -105,7 +105,7 @@ jobs:
105105
runs-on: ubuntu-latest
106106
steps:
107107
- name: Run Action
108-
uses: atlanhq/dbt-action@v1
108+
uses: atlanhq/atlan-action@v2
109109
with:
110110
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
111111
ATLAN_INSTANCE_URL: ${{secrets.ATLAN_INSTANCE_URL}}

SETUP.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ It is a very useful and easy to use library, which runs your Github Actions loca
3131

3232
Since you as a developer would be using your Github PAT to test the action locally, you'll need to locally run the clone of your fork, in order to generate the event.json file, follow the following steps:
3333

34-
- [Fork this repo.](https://github.com/atlanhq/dbt-action/fork)
34+
- [Fork this repo.](https://github.com/atlanhq/atlan-action/fork)
3535
- Create a pull request from `test-action` branch to `main` branch. Once you do so, it will automatically run the action.
3636
- Go to your forked repo's `Actions` page and open the workflow with the name `Test Action`.
3737
- Click on the one and only job, `Get Downstream Assets`.
@@ -58,4 +58,4 @@ Once and if `act` is setup properly, then you can simply use the command `npm st
5858

5959
## Contributing
6060

61-
Please make sure to use the command `npm run sync` in order to sync changes, since the workflow [`.github/workflows/package-action.yml`](https://github.com/atlanhq/dbt-action/blob/main/.github/workflows/package-action.yml) updates the `dist/` in order to package the action code in case you forget to package the action before pushing.
61+
Please make sure to use the command `npm run sync` in order to sync changes, since the workflow [`.github/workflows/package-action.yml`](https://github.com/atlanhq/atlan-action/blob/main/.github/workflows/package-action.yml) updates the `dist/` in order to package the action code in case you forget to package the action before pushing.

action.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
name: "Atlan dbt Action"
2-
description: "Whenever you make a change to a dbt model, Atlan will add downstream lineage impact context right in your pull requests."
1+
name: "Atlan Action"
2+
description: "Whenever you make a change to a dbt model or a data contract, Atlan will add downstream lineage impact context right in your pull requests."
33
author: "Atlan"
44

55
inputs:

adapters/templates/github-integration.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ export function getErrorResponseStatus401 (ATLAN_INSTANCE_URL, context) {
55
66
Atlan Instance URL: ${ATLAN_INSTANCE_URL}
77
8-
Set your repository action secrets [here](https://github.com/${context.payload.repository.full_name}/settings/secrets/actions). For more information on how to setup the Atlan dbt Action, please read the [setup documentation here](https://github.com/atlanhq/dbt-action/blob/main/README.md).`
8+
Set your repository action secrets [here](https://github.com/${context.payload.repository.full_name}/settings/secrets/actions). For more information on how to setup the Atlan Action, please read the [setup documentation here](https://github.com/atlanhq/atlan-action/blob/main/README.md).`
99
}
1010

1111
export function getErrorResponseStatusUndefined(ATLAN_INSTANCE_URL, context) {
@@ -16,7 +16,7 @@ Atlan Instance URL: ${ATLAN_INSTANCE_URL}
1616
Make sure your Atlan Instance URL is set in the following format.
1717
\`https://tenant.atlan.com\`
1818
19-
Set your repository action secrets [here](https://github.com/${context.payload.repository.full_name}/settings/secrets/actions). For more information on how to setup the Atlan dbt Action, please read the [setup documentation here](https://github.com/atlanhq/dbt-action/blob/main/README.md).`
19+
Set your repository action secrets [here](https://github.com/${context.payload.repository.full_name}/settings/secrets/actions). For more information on how to setup the Atlan Action, please read the [setup documentation here](https://github.com/atlanhq/atlan-action/blob/main/README.md).`
2020
}
2121

2222
export function getSetResourceOnAssetComment(tableMd, setResourceFailed) {

adapters/templates/gitlab-integration.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
import { getImageURL, getConnectorImage, getCertificationImage } from "../utils/index.js";
1+
import { getCertificationImage, getConnectorImage, getImageURL } from "../utils/index.js";
22

33
export function getErrorResponseStatus401 (ATLAN_INSTANCE_URL, CI_PROJECT_NAME, CI_PROJECT_NAMESPACE) {
44
return `We couldn't connect to your Atlan Instance, please make sure to set the valid Atlan Bearer Token as \`ATLAN_API_TOKEN\` as this repository's CI/CD variable.
55
66
Atlan Instance URL: ${ATLAN_INSTANCE_URL}
77
8-
Set your CI/CD variables [here](https://gitlab.com/${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}/-/settings/ci_cd). For more information on how to setup the Atlan dbt Action, please read the [setup documentation here](https://ask.atlan.com/hc/en-us/articles/8284983222415).`
8+
Set your CI/CD variables [here](https://gitlab.com/${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}/-/settings/ci_cd). For more information on how to setup the Atlan Action, please read the [setup documentation here](https://ask.atlan.com/hc/en-us/articles/8284983222415).`
99
}
1010

1111
export function getErrorResponseStatusUndefined(ATLAN_INSTANCE_URL, CI_PROJECT_NAME, CI_PROJECT_NAMESPACE) {
@@ -16,7 +16,7 @@ Atlan Instance URL: ${ATLAN_INSTANCE_URL}
1616
Make sure your Atlan Instance URL is set in the following format.
1717
\`https://tenant.atlan.com\`
1818
19-
Set your CI/CD variables [here](https://gitlab.com/${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}/-/settings/ci_cd). For more information on how to setup the Atlan dbt Action, please read the [setup documentation here](https://ask.atlan.com/hc/en-us/articles/8284983222415).`
19+
Set your CI/CD variables [here](https://gitlab.com/${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}/-/settings/ci_cd). For more information on how to setup the Atlan Action, please read the [setup documentation here](https://ask.atlan.com/hc/en-us/articles/8284983222415).`
2020
}
2121

2222
export function getSetResourceOnAssetComment(tableMd, setResourceFailed) {

dist/index.js

+13-4
Original file line numberDiff line numberDiff line change
@@ -24831,7 +24831,7 @@ function getErrorResponseStatus401 (ATLAN_INSTANCE_URL, context) {
2483124831

2483224832
Atlan Instance URL: ${ATLAN_INSTANCE_URL}
2483324833

24834-
Set your repository action secrets [here](https://github.com/${context.payload.repository.full_name}/settings/secrets/actions). For more information on how to setup the Atlan dbt Action, please read the [setup documentation here](https://github.com/atlanhq/dbt-action/blob/main/README.md).`
24834+
Set your repository action secrets [here](https://github.com/${context.payload.repository.full_name}/settings/secrets/actions). For more information on how to setup the Atlan Action, please read the [setup documentation here](https://github.com/atlanhq/atlan-action/blob/main/README.md).`
2483524835
}
2483624836

2483724837
function getErrorResponseStatusUndefined(ATLAN_INSTANCE_URL, context) {
@@ -24842,7 +24842,7 @@ Atlan Instance URL: ${ATLAN_INSTANCE_URL}
2484224842
Make sure your Atlan Instance URL is set in the following format.
2484324843
\`https://tenant.atlan.com\`
2484424844

24845-
Set your repository action secrets [here](https://github.com/${context.payload.repository.full_name}/settings/secrets/actions). For more information on how to setup the Atlan dbt Action, please read the [setup documentation here](https://github.com/atlanhq/dbt-action/blob/main/README.md).`
24845+
Set your repository action secrets [here](https://github.com/${context.payload.repository.full_name}/settings/secrets/actions). For more information on how to setup the Atlan Action, please read the [setup documentation here](https://github.com/atlanhq/atlan-action/blob/main/README.md).`
2484624846
}
2484724847

2484824848
function getSetResourceOnAssetComment(tableMd, setResourceFailed) {
@@ -25120,6 +25120,15 @@ async function getContractAsset({
2512025120
term: {
2512125121
qualifiedName: assetQualifiedName
2512225122
}
25123+
},
25124+
{
25125+
terms: {
25126+
"__typeName.keyword": [
25127+
"Table",
25128+
"MaterialisedView",
25129+
"View"
25130+
]
25131+
}
2512325132
}
2512425133
]
2512525134
}
@@ -39056,7 +39065,7 @@ function gitlab_integration_getErrorResponseStatus401 (ATLAN_INSTANCE_URL, CI_PR
3905639065

3905739066
Atlan Instance URL: ${ATLAN_INSTANCE_URL}
3905839067

39059-
Set your CI/CD variables [here](https://gitlab.com/${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}/-/settings/ci_cd). For more information on how to setup the Atlan dbt Action, please read the [setup documentation here](https://ask.atlan.com/hc/en-us/articles/8284983222415).`
39068+
Set your CI/CD variables [here](https://gitlab.com/${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}/-/settings/ci_cd). For more information on how to setup the Atlan Action, please read the [setup documentation here](https://ask.atlan.com/hc/en-us/articles/8284983222415).`
3906039069
}
3906139070

3906239071
function gitlab_integration_getErrorResponseStatusUndefined(ATLAN_INSTANCE_URL, CI_PROJECT_NAME, CI_PROJECT_NAMESPACE) {
@@ -39067,7 +39076,7 @@ Atlan Instance URL: ${ATLAN_INSTANCE_URL}
3906739076
Make sure your Atlan Instance URL is set in the following format.
3906839077
\`https://tenant.atlan.com\`
3906939078

39070-
Set your CI/CD variables [here](https://gitlab.com/${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}/-/settings/ci_cd). For more information on how to setup the Atlan dbt Action, please read the [setup documentation here](https://ask.atlan.com/hc/en-us/articles/8284983222415).`
39079+
Set your CI/CD variables [here](https://gitlab.com/${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}/-/settings/ci_cd). For more information on how to setup the Atlan Action, please read the [setup documentation here](https://ask.atlan.com/hc/en-us/articles/8284983222415).`
3907139080
}
3907239081

3907339082
function gitlab_integration_getSetResourceOnAssetComment(tableMd, setResourceFailed) {

package-lock.json

+3-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+8-7
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
11
{
2-
"name": "@atlanhq/dbt-action",
2+
"name": "@atlanhq/atlan-action",
33
"version": "1.0.0",
4-
"description": "Get all the downstream assets that get affected when dbt model sql files are changed on pull request conversations.",
4+
"description": "Get all the downstream assets that get affected when dbt model or data contract sql files are changed on pull request conversations.",
55
"main": "dist/index.js",
66
"type": "module",
77
"repository": {
88
"type": "git",
9-
"url": "git+https://github.com/atlanhq/dbt-action.git"
9+
"url": "git+https://github.com/atlanhq/atlan-action.git"
1010
},
1111
"keywords": [
1212
"github",
1313
"actions",
1414
"atlan",
1515
"atlanhq",
16-
"dbt-action"
16+
"dbt-action",
17+
"atlan-action"
1718
],
1819
"scripts": {
1920
"build": "ncc build adapters/index.js -o dist",
@@ -23,9 +24,9 @@
2324
"author": "Jaagrav Seal <[email protected]> (https://atlan.com/)",
2425
"license": "MIT",
2526
"bugs": {
26-
"url": "https://github.com/atlanhq/dbt-action/issues"
27+
"url": "https://github.com/atlanhq/atlan-action/issues"
2728
},
28-
"homepage": "https://github.com/atlanhq/dbt-action#readme",
29+
"homepage": "https://github.com/atlanhq/atlan-action#readme",
2930
"dependencies": {
3031
"@actions/core": "^1.10.0",
3132
"@actions/github": "^5.1.1",
@@ -43,4 +44,4 @@
4344
"devDependencies": {
4445
"@types/json-stringify-safe": "^5.0.2"
4546
}
46-
}
47+
}

0 commit comments

Comments
 (0)