Search…
Maintainer Docs

Setting up your environment

Please see the Development Guide for project level development instructions and Contributing Guide for specific details on how to set up your develop environment and contribute to Feast.

Maintainers Development

In most scenarios, your code changes or the areas of Feast that you are actively maintaining will only touch parts of the code(e.g one offline store/online store).

Forked Repo Best Practices

  1. 1.
    You should setup your fork so that you can make pull requests against your own master branch.
    • This prevents unnecessary integration tests and other github actions that are irrelevant to your code changes from being run everytime you would like to make a code change.
    • NOTE: Most workflows are enabled by default so manually disable workflows that are not needed.
  2. 2.
    When you are ready to merge changes into the official feast branch, make a pull request with the main feast branch and request a review from other maintainers.
    • Since your code changes should only touch tests that are relevant to your functionality, and other tests should pass as well.
NOTE: Remember to frequently sync your fork master branch with feast-dev/feast:master.

Github Actions Workflow on Fork

  • Recommended: The github actions workflows that should be enabled on the fork are as follows:
    • unit-tests
      • Runs all of the unit tests that should always pass.
    • linter
      • Lints your pr for styling or complexity issues using mypy, isort, and flake.
    • fork-pr-integration-tests-[provider]
      • Run all of the integration tests to test Feast functionality on your fork for a specific provider.
      • The .github/workflows folder has examples of common workflows(aws, gcp, and snowflake).
        1. 1.
          Move the fork_pr_integration_tests_[provider].yml from .github/fork_workflows to .github/workflows.
        2. 2.
          Edit fork_pr_integration_tests_[provider].yml (more details below) to only run the integration tests that are relevant to your area of interest.
        3. 3.
          Push the workflow to your branch and it should automatically be added to the actions on your fork.
    • build_wheels
      • Release verification workflow to use for release.

Integration Test Workflow Changes

Fork specific integration tests are run by the fork_pr_integration_tests.yml_[provider] yaml workflow files.
  1. 1.
    Under the integration-test-python job, replace your github repo with your feast github repo name.
  2. 2.
    If your offline store/online store needs special setup, add it to the job similar to how gcp is setup.
    - name: Set up gcloud SDK
    uses: google-github-actions/setup-[email protected]
    with:
    project_id: ${{ secrets.GCP_PROJECT_ID }}
    service_account_key: ${{ secrets.GCP_SA_KEY }}
    export_default_credentials: true
  3. 3.
    Add any environment variables that you need to your github secrets.
    • For specific github secrets that you will need to test the already supported datastores(e.g AWS, Bigquery, Snowflake, etc.) refer to this guide under the Integration Tests section.
    • Access these by setting environment variables as secrets.SECRET_NAME.
  4. 4.
    To limit pytest in your github workflow to test only your specific tests, leverage the -k option for pytest.
    pytest -n 8 --cov=./ --cov-report=xml --color=yes sdk/python/tests --integration --durations=5 --timeout=1200 --timeout_method=thread -k "BigQuery and not dynamo and not Redshift"
    • Each test in Feast is parametrized by its offline and online store so we can filter out tests by name. The above command chooses only tests with BigQuery that do not use Dynamo or Redshift.
  5. 5.
    Everytime a pull request or a change to a pull request is made, the integration tests, the local integration tests, the unit tests, and the linter should run.
Sample fork setups can be found here: snowflake and bigquery.
Export as PDF
Copy link
Edit on GitHub
On this page
Setting up your environment
Maintainers Development
Forked Repo Best Practices
Github Actions Workflow on Fork
Integration Test Workflow Changes