freature/work-type-support

.github/PULL_REQUEST_TEMPLATE/maintainer_pull_request_template.md

@@ -1,29 +1,38 @@
-## PR Overview
-**This PR will address the following Issue/Feature:**
+<!--
+Pre-Submission Reminders  
+Before marking this PR as "ready for review":
 
-**This PR will result in the following new package version:**
-<!--- Please add details around your decision for breaking vs non-breaking version upgrade. If this is a breaking change, were backwards-compatible options explored? -->
+- `dbt run --full-refresh && dbt test`  
+- `dbt run` && `dbt test` (if incremental models are present)  
+- The related issue is linked, tagged, and appropriately assigned  
+- Documentation and version updates are included, if applicable  
+- `docs` have been regenerated (unless there are no code or YAML changes)  
+- BuildKite integration tests are passing
+-->
 
-**Please provide the finalized CHANGELOG entry which details the relevant changes included in this PR:**
-<!--- Copy/paste the CHANGELOG for this version below. -->
+## PR Overview 
+**Package version introduced in this PR:** 
+- 
 
-## 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
+**This PR addresses the following Issue/Feature(s):**
+<!-- Add Issue # or internal ticket reference -->
+- 
 
-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
+**Summary of changes:**  
+<!-- 1-2 sentences describing PR changes. -->
+- 
 
-### Detailed Validation
-Please share any and all of your validation steps:
-<!--- Provide the steps you took to validate your changes below. -->
+### Submission Checklist  
+- [ ] Alignment meeting with the reviewer (if needed)  
+  - [ ] Timeline and validation requirements discussed  
+- [ ] Provide validation details:  
+  - [ ] **Validation Steps:** Check for unintentional effects (e.g., add/run consistency & integrity tests)
+  - [ ] **Testing Instructions:** Confirm the change addresses the issue(s)
+  - [ ] **Focus Areas:** Complex logic or queries that need extra attention  
+- [ ] Merge any relevant open PRs into this PR
 
-### If you had to summarize this PR in an emoji, which would it be?
-<!--- For a complete list of markdown compatible emojis check our this git repo (https://gist.github.com/rxaviers/7360908)  --> 
-:dancer:
+### Changelog  
+<!-- Recommend drafting changelog notes, then refining via ChatGPT using:  
+"Draft a changelog entry based on the following notes." -->
+- [ ] Draft changelog for PR  
+- [ ] Final changelog for release review

.github/workflows/auto-release.yml

@@ -3,11 +3,12 @@ on:
   pull_request:
     types:
       - closed
-    branches:
-      - main
+      - labeled
 
 jobs:
-  call-workflow-passing-data:
-    if: github.event.pull_request.merged
-    uses: fivetran/dbt_package_automations/.github/workflows/auto-release.yml@main
-    secrets: inherit
+  release:
+    if: |
+      (github.event.pull_request.merged == true && github.event.pull_request.base.ref == 'main') ||
+      github.event.label.name == 'pre-release'
+    uses: fivetran/dbt_package_automations/.github/workflows/auto-release.yml@feature/pre-release-support
+    secrets: inherit

.github/workflows/generate-docs.yml

@@ -0,0 +1,13 @@
+name: 'generate dbt docs'
+on:
+  pull_request:
+    types:
+      - labeled
+
+jobs:
+  generate-docs:
+    if: github.event.label.name == 'docs:ready'
+    uses: fivetran/dbt_package_automations/.github/workflows/generate-docs.yml@main
+    secrets: inherit
+    with:
+      schema_var_name: jira_schema

.gitignore

@@ -1,7 +1,73 @@
-target/
+# dbt
+**/package-lock.yml
+package-lock.yml
+.dbt/
 dbt_modules/
+dbt_packages/
 logs/
+profiles.yml
+target/
+*.log
+
+# IDE files
+.idea/
+.vscode/
+*~
+*.swp
+*.swo
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# OS generated files
+**/.DS_Store
 .DS_Store
-dbt_packages/
+.Spotlight-V100
+.Trashes
+._*
+Thumbs.db
+ehthumbs.db
+
+# Python
+*.egg
+*.egg-info/
+*.py[cod]
+*.so
+*$py.class
+.Python
+__pycache__/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.env
+.installed.cfg
+lib/
+lib64/
+MANIFEST
+parts/
+sdist/
+var/
+wheels/
+
+# Secrets and credentials
+.env.*
+.secrets
+credentials.json
+service-account.json
+
+# Temporary files
+.cache/
+*.temp
+*.tmp
+
+# Virtual environments
+.conda/
+.env
+.venv
+ENV/
 env/
-package-lock.yml
+env.bak/
+venv/
+venv.bak/

CHANGELOG.md

@@ -1,3 +1,25 @@
+# dbt_jira_source v0.9.1
+
+[PR #47](https://github.com/fivetran/dbt_jira_source/pull/47) introduces the following updates:
+
+## Feature Updates
+- Added support for Jira's `work_type` field within the `stg_jira__issue` model.
+  - The `stg_jira__issue` staging model now coalesces `work_type` with `issue_type` to generate the `issue_type_id` field with preference on `work_type`.
+  - This change aligns with [Atlassian's recent update](https://community.atlassian.com/forums/Jira-articles/It-s-here-Work-is-the-new-collective-term-for-all-items-you/ba-p/2954892), where “work item” is replacing the term “issue” across Jira. This ensures compatibility as Jira evolves.
+
+## Under the Hood
+- Introduced the generate-docs github workflow for consistent docs generation.
+- Included an updated version of the maintainer pull request template.
+- Updated the `issue` seed file to include the `work_type` field for integration testing.
+
+[PR #48](https://github.com/fivetran/dbt_jira_source/pull/48) includes the following updates:
+
+## July 2025 Updates
+- Updated conditions in `.github/workflows/auto-release.yml`.
+- Added `+docs: show: False` to `integration_tests/dbt_project.yml`.
+- Migrated `flags` (e.g., `send_anonymous_usage_stats`, `use_colors`) from `sample.profiles.yml` to `integration_tests/dbt_project.yml`.
+- Updated `.gitignore` to exclude additional DBT, Python, and system artifacts.
+
 # dbt_jira_source v0.9.0
 
 [PR #45](https://github.com/fivetran/dbt_jira_source/pull/45) includes the following updates:

README.md

@@ -5,14 +5,11 @@
         href="https://github.com/fivetran/dbt_jira_source/blob/main/LICENSE">
         <img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" /></a>
     <a alt="dbt-core">
-        <img src="https://img.shields.io/badge/dbt_Core™_version->=1.3.0_<2.0.0-orange.svg" /></a>
+        <img src="https://img.shields.io/badge/dbt_Core™_version->=1.3.0_,<2.0.0-orange.svg" /></a>
     <a alt="Maintained?">
         <img src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" /></a>
     <a alt="PRs">
         <img src="https://img.shields.io/badge/Contributions-welcome-blueviolet" /></a>
-    <a alt="Fivetran Quickstart Compatible"
-        href="https://fivetran.com/docs/transformations/dbt/quickstart">
-        <img src="https://img.shields.io/badge/Fivetran_Quickstart_Compatible%3F-yes-green.svg" /></a>
 </p>
 
 ## What does this dbt package do?
@@ -69,7 +66,7 @@ vars:
 
 ### (Optional) Step 5: Additional configurations
 <details><summary>Expand to view configurations</summary>
-    
+
 #### Change the build schema
 By default, this package builds the Jira staging models within a schema titled (`<target_schema>` + `_source_jira`) in your destination. If this is not where you would like your Jira staging data to be written to, add the following configuration to your root `dbt_project.yml` file:
 
@@ -78,25 +75,25 @@ models:
     jira_source:
       +schema: my_new_schema_name # leave blank for just the target_schema
 ```
-    
+
 #### Change the source table references
 If an individual source table has a different name than the package expects, add the table name as it appears in your destination to the respective variable:
 > IMPORTANT: See this project's [`dbt_project.yml`](https://github.com/fivetran/dbt_jira_source/blob/main/dbt_project.yml) variable declarations to see the expected names.
-    
+
 ```yml
 vars:
     jira_<default_source_table_name>_identifier: your_table_name 
 ```
-    
+
 </details>
 
 ### (Optional) Step 6: Orchestrate your models with Fivetran Transformations for dbt Core™
 <details><summary>Expand to view details</summary>
 <br>
-    
+
 Fivetran offers the ability for you to orchestrate your dbt project through [Fivetran Transformations for dbt Core™](https://fivetran.com/docs/transformations/dbt). Learn how to set up your project for orchestration through Fivetran in our [Transformations for dbt Core™ setup guides](https://fivetran.com/docs/transformations/dbt#setupguide).
 </details>
-    
+
 ## Does this package have dependencies?
 This dbt package is dependent on the following dbt packages. These dependencies are installed by default within this package. For more information on the following packages, refer to the [dbt hub](https://hub.getdbt.com/) site.
 > IMPORTANT: If you have any of these dependent packages in your own `packages.yml` file, we highly recommend that you remove them from your root `packages.yml` to avoid package version conflicts.
@@ -111,7 +108,7 @@ packages:
     - package: dbt-labs/spark_utils
       version: [">=0.3.0", "<0.4.0"]
 ```
-          
+
 ## How is this package maintained and can I contribute?
 ### Package Maintenance
 The Fivetran team maintaining this package _only_ maintains the latest version of the package. We highly recommend that you stay consistent with the [latest version](https://hub.getdbt.com/fivetran/jira_source/latest/) of the package and refer to the [CHANGELOG](https://github.com/fivetran/dbt_jira_source/blob/main/CHANGELOG.md) and release notes for more information on changes across versions.

dbt_project.yml

@@ -1,5 +1,5 @@
 name: 'jira_source'
-version: '0.8.0'
+version: '0.9.1'
 config-version: 2
 require-dbt-version: [">=1.3.0", "<2.0.0"]
 vars:

integration_tests/dbt_project.yml

@@ -1,5 +1,5 @@
 name: 'jira_source_integration_tests'
-version: '0.9.0'
+version: '0.9.1'
 config-version: 2
 profile: 'integration_tests'
 
@@ -34,6 +34,8 @@ models:
     +schema: "{{ 'jira_source_integrations_tests_sqlw' if target.name == 'databricks-sql' else 'jira_source' }}"
 
 seeds:
+  +docs:
+    show: False
   jira_source_integration_tests:
     +column_types:
       _fivetran_synced: timestamp
@@ -85,4 +87,5 @@ dispatch:
     search_order: ['spark_utils', 'dbt_utils']
 
 flags:
-  send_anonymous_usage_stats: False
+  send_anonymous_usage_stats: False
+  use_colors: True

integration_tests/seeds/issue.csv

@@ -1,4 +1,4 @@
-id,_fivetran_deleted,_fivetran_synced,_original_estimate,_remaining_estimate,_time_spent,assignee,created,creator,description,due_date,environment,issue_type,key,last_viewed,original_estimate,parent_id,priority,project,remaining_estimate,reporter,resolution,resolved,status,status_category_changed,summary,time_spent,updated,work_ratio
-10011,FALSE,2020-11-06 22:23:38,,,,,2020-04-01 08:33:58,5c3326c24b248c315badf3ee,"Yes, this is an issue to test permissions",,,10103,TP-8,,,,3,10001,,5c3326c24b248c315badf3ee,,2020-05-29 11:33:53,3,2020-04-01 08:34:02,We want to test permissions,,2020-05-29 11:33:53,-1
-10015,FALSE,2020-11-06 22:23:41,,,,,2020-06-11 07:38:03,5ed0edbe2999b60c23255b4f,,,,10103,TP-12,,,,5,10001,,5ed0edbe2999b60c23255b4f,,2020-06-11 07:38:03,10003,2020-06-11 07:38:03,Part of test epic,,2020-06-11 07:38:03,-1
-10018,FALSE,2020-11-12 12:20:50,,,,,2020-11-10 19:11:45,557058:a9572f6a-3041-435a-96ed-5286e3811b33,,,,10103,TCP-1,2020-11-10 19:11:46,,,3,10005,,557058:a9572f6a-3041-435a-96ed-5286e3811b33,,2020-11-28 19:11:45,10003,2020-11-28 19:11:46,this is a story,,2020-11-28 19:11:45,-1
+id,_fivetran_deleted,_fivetran_synced,_original_estimate,_remaining_estimate,_time_spent,assignee,created,creator,description,due_date,environment,issue_type,key,last_viewed,original_estimate,parent_id,priority,project,remaining_estimate,reporter,resolution,resolved,status,status_category_changed,summary,time_spent,updated,work_ratio,work_type
+10011,FALSE,2020-11-06 22:23:38,,,,,2020-04-01 08:33:58,5c3326c24b248c315badf3ee,"Yes, this is an issue to test permissions",,,10103,TP-8,,,,3,10001,,5c3326c24b248c315badf3ee,,2020-05-29 11:33:53,3,2020-04-01 08:34:02,We want to test permissions,,2020-05-29 11:33:53,-1,10103
+10015,FALSE,2020-11-06 22:23:41,,,,,2020-06-11 07:38:03,5ed0edbe2999b60c23255b4f,,,,,TP-12,,,,5,10001,,5ed0edbe2999b60c23255b4f,,2020-06-11 07:38:03,10003,2020-06-11 07:38:03,Part of test epic,,2020-06-11 07:38:03,-1,10103
+10018,FALSE,2020-11-12 12:20:50,,,,,2020-11-10 19:11:45,557058:a9572f6a-3041-435a-96ed-5286e3811b33,,,,10103,TCP-1,2020-11-10 19:11:46,,,3,10005,,557058:a9572f6a-3041-435a-96ed-5286e3811b33,,2020-11-28 19:11:45,10003,2020-11-28 19:11:46,this is a story,,2020-11-28 19:11:45,-1,

macros/get_issue_columns.sql

@@ -14,8 +14,8 @@
     {"name": "environment", "datatype": dbt.type_string()},
     {"name": "id", "datatype": dbt.type_int()},
     {"name": "issue_type", "datatype": dbt.type_int()},
+    {"name": "work_type", "datatype": dbt.type_int()},
     {"name": "key", "datatype": dbt.type_string()},
-
     {"name": "original_estimate", "datatype": dbt.type_float()},
     {"name": "parent_id", "datatype": dbt.type_int()},
     {"name": "priority", "datatype": dbt.type_int()},

models/src_jira.yml

@@ -102,7 +102,9 @@ sources:
           - name: environment
             description: Text field describing the environment in which the issue occurred (ie "IE9 on Windows 7").
           - name: issue_type
-            description: Foreign key referencing the ID of the `issue_type`. 
+            description: Foreign key referencing the ID of the `issue_type`.
+          - name: work_type
+            description: Issue type ID for connectors that no longer sync the `issue_type` column.
           - name: key
             description: UI-facing id of the issue.
           - name: last_viewed

models/stg_jira.yml

@@ -102,7 +102,9 @@ models:
       - name: environment
         description: Text field describing the environment in which the issue occurred (ie "IE9 on Windows 7").
       - name: issue_type_id
-        description: Foreign key referencing the ID of the `issue_type`. 
+        description: >
+          Foreign key referencing the ID of the `issue_type`. This value is generated
+          by coalescing the `work_type` and `issue_type` columns from the source.
       - name: issue_key
         description: UI-facing id of the issue.
       - name: original_estimate_seconds

models/stg_jira__issue.sql

@@ -31,7 +31,7 @@ final as (
         due_date,
         environment,
         id as issue_id,
-        issue_type as issue_type_id,
+        coalesce(work_type, issue_type) as issue_type_id,
         key as issue_key,
         parent_id as parent_issue_id,
         priority as priority_id,