Skip to content

Latest commit

 

History

History
90 lines (74 loc) · 7.17 KB

README.md

File metadata and controls

90 lines (74 loc) · 7.17 KB
Raw

early-release Release License Discourse posts

snowplow-logo

This is a template repo for new dbt packages within Snowplow. To use this template, follow the instructions for Creating a repository from a template then follow these steps:

  1. Update this README.md with relevant information, deleting these instructions and replacing all text including in badge links
  2. Update the .github/workflows/release.yml with your package name
  3. Update the .github/workflows/publish-gh-pages.yml to have it run on main, selecting the appropriate warehouse for you
  4. Update the .github/pull_request_template.md with your package name
  5. Update the CHANGELOG with your package name
  6. Update the CONTRIBUTING.md with your package name
  7. Name your package in the dbt_project.yml
  8. Included in this template are the base models that should be used across all Snowplow packages. These models take advantage of the incremental framework built in the Utils base macros so you won't have to do the initial heavy lifting yourself. You will need to update the following:
    1. Update all model file names, replacing all
    2. Update all reference inside the models, replacing text
    3. Update any of the base macro variables in the dbt_project.yml if needed
  9. Update all ./docs/markdown file names and replace references of text
  10. Update the template Integration test suite found in ./integration_tests replacing all
  11. Commit these changes
  12. Add the relevant users/teams to your repo
  13. Update the repo settings to the following:
  14. Features:
    • Wikis
    • Issues
    • Allow forking
    • Sponsorships
    • Preserve this repository
    • Discussions
    • Projects 2. Pull Requests:
    • Allow merge commits
    • Allow squash merging (Default to pull request title)
    • Allow rebase merging
    • Always suggest updating pull request branches
    • Allow auto-merge
    • Automatically delete head branches
  15. Add branch protection on main and release/**/* with the following settings:
    • Require a pull request before merging (unticked for release branch)
      • Require approvals
    • Require status checks to pass before merging (pick specific status checks once they are added)
      • Require branches to be up to date before merging
    • Require conversation resolution before merging
    • Require signed commits
    • Require linear history
    • Require deployments to succeed before merging
    • Lock branch
    • Do not allow bypassing the above setting (unticked for release branch)
    • Restrict who can push to matching branches
    • Allow force pushes (ticked for release branch)
    • Allow deletions (ticked for release branch)
  16. Add the relevant warehouse connection secrets required for in the ./integration_tests

Join the Snowplow community

We welcome all ideas, questions and contributions!

For support requests, please use our community support Discourse forum.

If you find a bug, please report an issue on GitHub.

Copyright and license

The package is Copyright 2023-present Snowplow Analytics Ltd.

This distribution is all licensed under the Snowplow Personal and Academic License . (If you are uncertain how it applies to your use case, check our answers to frequently asked questions.)