Skip to content

Latest commit

 

History

History
101 lines (58 loc) · 5.33 KB

CONTRIBUTING.md

File metadata and controls

101 lines (58 loc) · 5.33 KB
Raw

Contributing to actions

actions is a public repository of shared github actions and workflows primarily utilized by the core group

  1. About this document
  2. Getting the code
  3. Setting up an environment
  4. Running in development
  5. Testing
  6. Debugging
  7. Adding or modifying a changelog entry
  8. Submitting a Pull Request
  9. Troubleshooting Tips

About this document

There are many ways to contribute to the ongoing development of actions, such as by participating in discussions and issues. We encourage you to first read our higher-level document: "Expectations for Open Source Contributors".

The rest of this document serves as a more granular guide for contributing code changes to actions (this repository). It is not intended as a guide for using actions, and some pieces assume a level of familiarity with Python development (virtualenvs, pip, etc). Specific code snippets in this guide assume you are using macOS or Linux and are comfortable with the command line.

Notes

  • CLA: Please note that anyone contributing code to actions must sign the Contributor License Agreement. If you are unable to sign the CLA, the actions maintainers will unfortunately be unable to merge any of your Pull Requests. We welcome you to participate in discussions, open issues, and comment on existing ones.
  • Branches: All pull requests from community contributors should target the main branch (default).
  • Releases: This repository is never released. We reserve the right to tag actions and workflows in the future.

Getting the code

Installing git

You will need git in order to download and modify the source code.

External contributors

If you are not a member of the dbt-labs GitHub organization, you can contribute to actions by forking the actions repository. For a detailed overview on forking, check out the GitHub docs on forking. In short, you will need to:

  1. Fork the actions repository
  2. Clone your fork locally
  3. Check out a new branch for your proposed changes
  4. Push changes to your fork
  5. Open a pull request against dbt-labs/actions from your forked repository

dbt Labs contributors

If you are a member of the dbt-labs GitHub organization, you will have push access to the actions repo. Rather than forking actions to make your changes, just clone the repository, check out a new branch, and push directly to that branch.

Tools

These are the tools used in actions development and testing:

A deep understanding of these tools in not required to effectively contribute to actions, but we recommend checking out the attached documentation if you're interested in learning more about each one.

Running actions in development

Installation

None

Running actions

  • Each workflow can be run independently, depending on its trigger
  • See list of trigger in the GitHub docs
  • It can be helpful to create a dummy repository to trigger actions and workflow

Initial setup

None needed.

Test commands

No tests included.

Debugging

You can enable debug logging for GHA by setting secret values for your repository. See docs for more info.

  • Set ACTIONS_RUNNER_DEBUG to true to enable runner diagnostic logging.
  • Set ACTIONS_STEP_DEBUG to true to enable run step debug logging.

Assorted development tips

  • TBD

Submitting a Pull Request

Code can be merged into the current development branch main by opening a pull request. An actions maintainer will review your PR. They may suggest code revision for style or clarity, or request that you add unit or integration test(s). These are good things! We believe that, with a little bit of help, anyone can contribute high-quality code.

Automated tests run via GitHub Actions. If you're a first-time contributor, all tests (including code checks and unit tests) will require a maintainer to approve. Changes in the actions repository trigger integration tests against Postgres. dbt Labs also provides CI environments in which to test changes to other adapters, triggered by PRs in those adapters' repositories, as well as periodic maintenance checks of each adapter in concert with the latest actions code changes.

Once all tests are passing and your PR has been approved, an actions maintainer will merge your changes into the active development branch. And that's it! Happy developing 🎉

Troubleshooting Tips

  • Sometimes, the content license agreement auto-check bot doesn't find a user's entry in its roster. If you need to force a rerun, add @cla-bot check in a comment on the pull request.