Skip to content

Commit

Permalink
Merge pull request #2481 from dbt-labs/joellabes-patch-1
Browse files Browse the repository at this point in the history
Update README.md to explain how to remove/redirect package
  • Loading branch information
joellabes authored May 17, 2023
2 parents 41609e2 + 6d6035b commit 47e99ed
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,15 @@ Package hub for [dbt](https://www.getdbt.com).
## Adding a new package

The `hubcap.py` script which generates PRs for new versions of packages is hosted at https://github.com/dbt-labs/hubcap and runs hourly on Heroku. To add a new package to the hub index, create a PR which adds the package name to [this file](https://github.com/dbt-labs/hubcap/blob/master/hub.json).

## Rename a package

Renaming a package involves two steps:
1. Redirecting from the old name to the new name
1. Removing the old name from the hub homepage

To notify users of a new package name, add a `"redirectname"` key to `data/packages/ORG_NAME/OLD_PACKAGE_NAME/index.json`.

To remove an old package name from the hub homepage, add it to [blocklist.json](data/blocklist.json).

See [#1539](https://github.com/dbt-labs/hub.getdbt.com/pull/1539/files) for an example of both steps.

0 comments on commit 47e99ed

Please sign in to comment.