You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Migrate actions from dbt-adapters and establish a style standard and best practices guide for both action structure and repo structure.
Context
We need to perform regular automation across open source repos. When dbt-adapters was setup, new actions were hosted there because they needed to support hatch. We should migrate those actions to dbt-labs/actions so that we don't have two sources of truth.
Given the size of the migration, this is a good time to consider establishing a style standard and best practices.
A draft of these changes can be seen on https://github.com/dbt-labs/actions/tree/add-hatch-actions. This draft makes a lot of assumptions, combines several changes in parallel, and has not been tested; however it demonstrates the goal conceptually.
Objectives
We have a central repository of robust and reusable actions
We have a style guide that removes individual preference debates from PR reviews
We have a best practices guide that can be used prior to requesting a PR review
The content you are editing has changed. Please copy your edits and refresh the page.
New actions are tested against another repo prior to merging
Security
Our actions have access to credentials and get run indirectly by third party contributors. We should consult Security for the best practices guide.
Docs
Each action should have some level of documentation explaining how to use it and why certain decisions were made if they are not intuitive. This should be in the same directory as the action.
We might want to consider sharing the guide and practices in dbt-labs/oss-at-dbt.
Short description
Migrate actions from
dbt-adapters
and establish a style standard and best practices guide for both action structure and repo structure.Context
We need to perform regular automation across open source repos. When
dbt-adapters
was setup, new actions were hosted there because they needed to supporthatch
. We should migrate those actions todbt-labs/actions
so that we don't have two sources of truth.Given the size of the migration, this is a good time to consider establishing a style standard and best practices.
A draft of these changes can be seen on https://github.com/dbt-labs/actions/tree/add-hatch-actions. This draft makes a lot of assumptions, combines several changes in parallel, and has not been tested; however it demonstrates the goal conceptually.
Objectives
PRs
changie/changelog/create
action #192changie/changelog/view
action #193github/branch/create
action #194github/branch/edit
action #195github/commit/create
action #196github/commit/view
action #197github/release/create
action #198github/release/edit
action #199github/release/view
action #200github/team/view
action #201hatch/artifact/create
action #202hatch/environment/create
action #204hatch/version/edit
action #203pypi/release/create
action #205Testing
Security
Our actions have access to credentials and get run indirectly by third party contributors. We should consult Security for the best practices guide.
Docs
Each action should have some level of documentation explaining how to use it and why certain decisions were made if they are not intuitive. This should be in the same directory as the action.
We might want to consider sharing the guide and practices in
dbt-labs/oss-at-dbt
.Some draft work has been done in this PR: #172
Consequences
Pro's
Con's
The text was updated successfully, but these errors were encountered: