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 #8

Merged
merged 1 commit into from
Oct 8, 2024
Merged

DQ-420 docs: modify readme #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 10 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ We've created a GitHub Action to help you out — putting Atlan's impact analysi

Here's what it looks like 👇

![GitHub Action comment screenshot](https://iili.io/HI7d0zB.png)
![GitHub Action comment screenshot](https://github.com/user-attachments/assets/75db2cb9-f62b-4696-9918-e70b7360b022)

## Prerequisites

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

![Actions Secrets Screenshot](https://iili.io/HI7gfx2.png)
![Actions Secrets Screenshot](https://github.com/user-attachments/assets/8eb94830-08f0-4ad5-9186-813c6a00e8e3)

2. Add the GitHub Action to your workflow:

Expand All @@ -42,12 +42,17 @@ Here's what it looks like 👇
name: Get Downstream Assets
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Run Action
uses: atlanhq/atlan-action@v2
uses: atlanhq/atlan-action@v1
with:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
ATLAN_INSTANCE_URL: ${{secrets.ATLAN_INSTANCE_URL}}
ATLAN_API_TOKEN: ${{secrets.ATLAN_API_TOKEN}}
# Add ATLAN_CONFIG to run impact analysis on contracts
ATLAN_CONFIG: .atlan/config.yaml
```

## Test the action
Expand Down Expand Up @@ -84,7 +89,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Run Action
uses: atlanhq/atlan-action@v2
uses: atlanhq/atlan-action@v1
with:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
ATLAN_INSTANCE_URL: ${{secrets.ATLAN_INSTANCE_URL}}
Expand All @@ -105,7 +110,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Run Action
uses: atlanhq/atlan-action@v2
uses: atlanhq/atlan-action@v1
with:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
ATLAN_INSTANCE_URL: ${{secrets.ATLAN_INSTANCE_URL}}
Expand Down