Feature/ga bp envs (#62)

* wip

* Add event-name and release tag

* Add support for release-tag

* PR info in push

* Add debug logs

* remove {} from authors for bitbucket

* pipeline detection for pr

* Always get author

Author: riteshnoronha

README.md

@@ -314,6 +314,7 @@ PyLynk automatically detects and captures CI/CD environment information when run
 ### Automatic PR and Build Information Extraction
 
 When running in a CI environment during SBOM uploads, PyLynk automatically extracts:
+- **Event Information**: Event type (pull_request, push, release), release tag (when applicable)
 - **Pull Request Information**: PR number, URL, source/target branches, **author** (when in PR context)
 - **Build Information**: Build ID, number, URL, commit SHA
 - **Repository Information**: Repository name, owner, URL
@@ -333,6 +334,8 @@ on:
     branches: [ main ]
   push:
     branches: [ main ]
+  release:
+    types: [ published ]
 
 jobs:
   upload-sbom:
@@ -350,6 +353,8 @@ jobs:
         run: |
           python3 pylynk.py upload --prod 'my-product' --sbom sbom.json
           # PyLynk automatically captures:
+          # - Event type (pull_request, push, or release)
+          # - Release tag (for release events)
           # - PR number and branches (for pull_request events)
           # - PR author (GITHUB_ACTOR)
           # - Commit SHA and build URL
@@ -369,8 +374,17 @@ pipelines:
           script:
             - pip install -r requirements.txt
             - python3 pylynk.py upload --prod 'my-product' --sbom sbom.json
+  tags:
+    'v*':
+      - step:
+          name: Upload SBOM for Release
+          script:
+            - pip install -r requirements.txt
+            - python3 pylynk.py upload --prod 'my-product' --sbom sbom.json
           # PyLynk automatically captures:
-          # - PR ID and branches
+          # - Event type (pull_request, push, or release)
+          # - Release tag (for tag-triggered builds)
+          # - PR ID and branches (for PR events)
           # - PR author (BITBUCKET_STEP_TRIGGERER_UUID)
           # - Build number and URL
           # - Repository information
@@ -385,6 +399,10 @@ PyLynk also supports generic CI environments by checking common environment vari
 | Variable | Description | Maps to Header |
 |----------|-------------|----------------|
 | `CI` | Set to `true` to indicate CI environment | Enables CI detection |
+| **Release Variables** | | |
+| `GIT_TAG` | Git tag for release builds | `X-Release-Tag` |
+| `CI_COMMIT_TAG` | GitLab CI tag variable | `X-Release-Tag` |
+| `TAG_NAME` | Alternative tag name variable | `X-Release-Tag` |
 | **Pull Request Variables** | | |
 | `PULL_REQUEST_NUMBER` | PR number | `X-PR-Number` |
 | `PR_NUMBER` | Alternative PR number variable | `X-PR-Number` |
@@ -488,6 +506,8 @@ The extracted CI information is sent as HTTP headers with upload API requests:
 | Header | Description | Example |
 |--------|-------------|---------|
 | `X-CI-Provider` | CI platform name | `github_actions`, `bitbucket_pipelines`, `generic_ci` |
+| `X-Event-Type` | CI event type | `pull_request`, `push`, `release` |
+| `X-Release-Tag` | Release tag name (when event is release) | `v1.2.3` |
 | `X-PR-Number` | Pull request number | `123` |
 | `X-PR-URL` | Pull request URL | `https://github.com/org/repo/pull/123` |
 | `X-PR-Source-Branch` | PR source branch | `feature/new-feature` |

pylynk/api/client.py

@@ -115,19 +115,29 @@ def _get_headers(self):
                 # Add as custom headers
                 headers['X-CI-Provider'] = ci_metadata.get('ci_provider', 'unknown')
 
-                # Add PR information if available
-                if 'pr' in ci_metadata:
-                    pr_info = ci_metadata['pr']
-                    if 'number' in pr_info:
-                        headers['X-PR-Number'] = str(pr_info['number'])
-                    if 'url' in pr_info:
-                        headers['X-PR-URL'] = pr_info['url']
-                    if 'source_branch' in pr_info:
-                        headers['X-PR-Source-Branch'] = pr_info['source_branch']
-                    if 'target_branch' in pr_info:
-                        headers['X-PR-Target-Branch'] = pr_info['target_branch']
-                    if 'author' in pr_info:
-                        headers['X-PR-Author'] = pr_info['author']
+                # Add event information if available
+                if 'event' in ci_metadata:
+                    event_info = ci_metadata['event']
+                    
+                    # Add event type
+                    if 'event_type' in event_info:
+                        headers['X-Event-Type'] = event_info['event_type']
+                    
+                    # Add release tag if available
+                    if 'release_tag' in event_info:
+                        headers['X-Release-Tag'] = event_info['release_tag']
+                    
+                    # Add PR information if available
+                    if 'number' in event_info:
+                        headers['X-PR-Number'] = str(event_info['number'])
+                    if 'url' in event_info:
+                        headers['X-PR-URL'] = event_info['url']
+                    if 'source_branch' in event_info:
+                        headers['X-PR-Source-Branch'] = event_info['source_branch']
+                    if 'target_branch' in event_info:
+                        headers['X-PR-Target-Branch'] = event_info['target_branch']
+                    if 'author' in event_info:
+                        headers['X-PR-Author'] = event_info['author']
 
                 # Add build information if available
                 if 'build' in ci_metadata:
@@ -144,14 +154,17 @@ def _get_headers(self):
                         headers['X-Repository-URL'] = repo_info['url']
 
                 # Log CI metadata in debug mode
-                pr_context = self.config.ci_info.get_pr_context_string()
-                if pr_context:
-                    logging.debug(f"CI Context: {pr_context}")
+                event_context = self.config.ci_info.get_event_context_string()
+                if event_context:
+                    logging.debug(f"CI Context: {event_context}")
 
                 # Log the headers being sent (excluding auth token for security)
                 logged_headers = {k: v for k, v in headers.items() if k != 'Authorization'}
                 if logged_headers:
-                    logging.debug(f"CI Headers: {logged_headers}")
+                    logging.debug("CI/CD Headers being sent:")
+                    for header_name, header_value in sorted(logged_headers.items()):
+                        if header_name.startswith('X-'):
+                            logging.debug(f"  {header_name}: {header_value}")
 
         return headers
 
@@ -465,6 +478,11 @@ def upload_sbom(self, sbom_file):
                       self._format_size(file_size))
 
         headers = self._get_headers()
+        
+        # Log summary of CI headers if present
+        ci_headers = {k: v for k, v in headers.items() if k.startswith('X-') and k != 'Authorization'}
+        if ci_headers:
+            logging.debug(f"Including {len(ci_headers)} CI/CD metadata headers in upload request")
 
         operations = json.dumps({
             "query": SBOM_UPLOAD,