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.

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

[Release Improvements] Migrate actions from dbt-adapters #173

Open
16 tasks
mikealfare opened this issue Apr 27, 2024 · 0 comments
Open
16 tasks

[Release Improvements] Migrate actions from dbt-adapters #173

mikealfare opened this issue Apr 27, 2024 · 0 comments

Comments

@mikealfare
Copy link
Contributor

mikealfare commented Apr 27, 2024

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

Testing

  • 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.

Some draft work has been done in this PR: #172

Consequences

Pro's

  • finding and using an action will be easier
  • standards make for less human error and easier maintainability

Con's

  • using these actions will require a migration in all dependent repos
@mikealfare mikealfare added enhancement New feature or request epic labels Apr 27, 2024
@mikealfare mikealfare changed the title [Feature] Migrate hatch actions from dbt-adapters [Epic] Migrate hatch actions from dbt-adapters Apr 27, 2024
@mikealfare mikealfare changed the title [Epic] Migrate hatch actions from dbt-adapters [Epic] Migrate actions from dbt-adapters Apr 27, 2024
@mikealfare mikealfare changed the title [Epic] Migrate actions from dbt-adapters [Feature] Migrate actions from dbt-adapters Apr 28, 2024
@mikealfare mikealfare removed the enhancement New feature or request label Apr 28, 2024
@mikealfare mikealfare changed the title [Feature] Migrate actions from dbt-adapters [Release Improvements] Migrate actions from dbt-adapters May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants