Skip to content

Commit

Permalink
fix: updates to setup docs and update event.json
Browse files Browse the repository at this point in the history
  • Loading branch information
Jaagrav committed Nov 23, 2022
1 parent cd797f5 commit 707b9f5
Show file tree
Hide file tree
Showing 3 changed files with 331 additions and 270 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Get comments about downstream assets affected when you make changes to your dbt
runs-on: ubuntu-latest
steps:
- name: Run Action
uses: atlan/dbt-action@v1
uses: atlanhq/dbt-action@v1
with:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
ATLAN_INSTANCE_URL: ${{secrets.ATLAN_INSTANCE_URL}}
Expand Down
17 changes: 17 additions & 0 deletions SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,23 @@ It is a very useful and easy to use library, which runs your Github Actions loca
IS_DEV=true
```

## Create `event.json` to test the action locally

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:

- [Fork this repo.](https://github.com/atlanhq/dbt-action/fork)
- Create a pull request from `test-action` branch to `main` branch. Once you do so, it will automatically run the action.
- Go to your forked repo's `Actions` page and open the workflow with the name `Test Action`.
- Click on the one and only job, `Get Downstream Assets`.
- Click on the step called `Dump GitHub Context` and you'll find a huge json object containing the key `"event"`, copy all of the content present inside this key.
- Create `event.json` in your root directory.
- Paste all the content you copied in this file
```json
{
// ... Paste your copied content ...
}
```

## Test Action Locally

Test on macOS with Apple Silicon processors.
Expand Down
Loading

0 comments on commit 707b9f5

Please sign in to comment.