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

feature/fb-pages-apr-2024-api-update #8

Merged
merged 9 commits into from
Jun 12, 2024

Conversation

fivetran-catfritz
Copy link
Contributor

@fivetran-catfritz fivetran-catfritz commented Jun 4, 2024

PR Overview

This PR will address the following Issue/Feature:

This PR will result in the following new package version:

  • v0.4.0: breaking due to schema changes in the dbt_facebook_pages_source package (deleting columns)

Please provide the finalized CHANGELOG entry which details the relevant changes included in this PR:

🚨 Breaking Changes 🚨:

  • This change is made breaking due to changes made in the dbt_facebook_pages_source and dbt_facebook_pages packages. Columns have been removed in the source package (see the dbt_facebook_pages_source v0.3.0 CHANGELOG for more details).
    • No columns were changed in the end models in this package, however if you use the Facebook Pages staging models independently, you will need to update your downstream use cases accordingly.
    • Columns removed from staging model stg_facebook_pages__daily_page_metrics_total:
      • consumptions
      • content_activity
      • engaged_users
      • places_checkin_mobile
      • views_external_referrals
      • views_logged_in_total
      • views_logout
    • Columns removed from staging model stg_facebook_pages__lifetime_post_metrics_total:
      • impressions_fan_paid

Features

  • Updated documentation to reflect the current schema.

Under the Hood:

  • Updated the pull request templates.
  • Included auto-releaser GitHub Actions workflow to automate future releases.

PR Checklist

Basic Validation

Please acknowledge that you have successfully performed the following commands locally:

  • dbt run –full-refresh && dbt test
  • dbt run (if incremental models are present) && dbt test

Before marking this PR as "ready for review" the following have been applied:

  • The appropriate issue has been linked, tagged, and properly assigned
  • All necessary documentation and version upgrades have been applied
  • docs were regenerated (unless this PR does not include any code or yml updates)
  • BuildKite integration tests are passing
  • Detailed validation steps have been provided below

Detailed Validation

Please share any and all of your validation steps:

  • Columns have been removed in the source but do not change the output of this package.

If you had to summarize this PR in an emoji, which would it be?

📄

@fivetran-catfritz fivetran-catfritz self-assigned this Jun 4, 2024
Copy link
Collaborator

@fivetran-joemarkiewicz fivetran-joemarkiewicz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! But let's hold off releasing until next week in case there are other considerations we should take into account with breaking changes.

packages.yml Outdated
Comment on lines 2 to 6
# - package: fivetran/facebook_pages
# version: [">=0.3.0", "<0.4.0"]
- git: https://github.com/fivetran/dbt_facebook_pages.git
revision: feature/apr-2024-api-update
warn-unpinned: false
Copy link
Collaborator

@fivetran-joemarkiewicz fivetran-joemarkiewicz Jun 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reminder to update before merge

Copy link
Contributor

@fivetran-avinash fivetran-avinash Jun 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fivetran-catfritz This should be

  • package: fivetran/facebook_pages
    version: [">=0.3.0", "<0.4.0"]

Your commented version was right, don't use the above suggestion.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching this @fivetran-avinash. I like this approach @fivetran-catfritz to update the comment so you can easily swap when making these releases.

Apologies for overlooking this in the initial review. I have removed my suggestion.

CHANGELOG.md Outdated
- Columns removed from staging model `stg_facebook_pages__lifetime_post_metrics_total`:
- `impressions_fan_paid`

## Features
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documentation isn't updated in this package, you can remove this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you expand a little on what you mean? I thought this should still be included since the fb pages packages are still installed, and the removed columns also carry through to the models and regenerated docs.

Copy link
Contributor

@fivetran-avinash fivetran-avinash Jun 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I thought this was referring to yml updates. I guess the columns are being removed!

I'd suggest renaming this to be Documentation Updates then, as this doesn't seem like a Feature. Not super important though, as you've already started merging in the other releases.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like that suggestion--thank you and updated!

Copy link
Contributor

@fivetran-avinash fivetran-avinash left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fivetran-catfritz The versions on the README need to be bumped, one important note on the packages.yml, and one small comment on the CHANGELOG. Once that's done this is good to go!

@fivetran-catfritz
Copy link
Contributor Author

@fivetran-avinash Thanks for the review! I bumped the readme (thank you for catching!), and I'm thinking the changelog can be kept as-is. Let me know what you think!

Copy link
Contributor

@fivetran-avinash fivetran-avinash left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One suggestion to your reply but totally optional. lgtm!

packages.yml Outdated Show resolved Hide resolved
@fivetran-catfritz fivetran-catfritz merged commit b2d4c7c into main Jun 12, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug] Facebook removed fields from all versions of the API
3 participants