Add docs

Author: brancz

README.md

@@ -12,3 +12,45 @@ If you are using Polar Signals cloud, the only thing required to configure is th
 
 Profiling data from one CI run looks [like this](https://pprof.me/475d1cc/).
 
+## Deployment Links
+
+This action can automatically create GitHub deployments with links to your profiling data, making it easy to access the results directly from your GitHub repository. For this feature to work, the following parameters must be configured:
+
+- `project_uuid`: Your Polar Signals Cloud project UUID
+
+If any of the required parameters are missing, the deployment creation will be skipped without failing the workflow, and log messages will indicate the reason.
+
+### Required Permissions
+
+For the deployment creation to work, your workflow needs the following permissions:
+
+```yaml
+permissions:
+  deployments: write
+  contents: read
+```
+
+### Example Configuration
+
+```yaml
+name: Profiling Workflow
+on: [push]
+
+permissions:
+  deployments: write
+  contents: read
+
+jobs:
+  profile:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      
+      - name: Run Continuous Profiling
+        uses: polarsignals/gh-actions-ps-profiling@main
+        with:
+          polarsignals_cloud_token: ${{ secrets.POLARSIGNALS_CLOUD_TOKEN }}
+          project_uuid: 'your-project-uuid-here'
+          labels: 'branch=${{ github.ref_name }};workflow=${{ github.workflow }}'
+```
+

index.js

@@ -187,25 +187,24 @@ async function post() {
     // Set output for the action
     core.setOutput('profiling_url', queryUrl);
 
-    // Create a GitHub deployment if running in GitHub Actions
+    // Create a GitHub deployment if running in GitHub Actions and all required parameters are available
     if (process.env.GITHUB_ACTIONS) {
       try {
         const github_token = core.getInput('github_token');
-        const octokit = require('@octokit/rest');
-        const { Octokit } = octokit;
-        const client = new Octokit({
-          auth: github_token
-        });
-
-        // Get GitHub context
         const repository = process.env.GITHUB_REPOSITORY;
         const [owner, repo] = (repository || '').split('/');
         const ref = process.env.GITHUB_REF || process.env.GITHUB_SHA;
 
-        if (owner && repo && ref) {
-          // Create a deployment
+        // Check if all required parameters are available for deployment
+        if (github_token && owner && repo && ref && projectUuid && queryUrl) {
           core.info(`Creating deployment for ${owner}/${repo} at ${ref}`);
 
+          const octokit = require('@octokit/rest');
+          const { Octokit } = octokit;
+          const client = new Octokit({
+            auth: github_token
+          });
+          
           const deployment = await client.repos.createDeployment({
             owner,
             repo,
@@ -235,7 +234,12 @@ async function post() {
             core.info(`Created deployment with ID: ${deploymentId}`);
           }
         } else {
-          core.warning(`Missing GitHub context information: owner=${owner}, repo=${repo}, ref=${ref}`);
+          core.info('Skipping GitHub deployment creation due to missing required parameters:');
+          if (!github_token) core.info('- Missing github_token');
+          if (!owner || !repo) core.info(`- Missing repository information: ${repository}`);
+          if (!ref) core.info('- Missing ref information');
+          if (!projectUuid) core.info('- Missing project_uuid');
+          if (!queryUrl) core.info('- Missing queryUrl');
         }
       } catch (deployError) {
         core.warning(`Failed to create GitHub deployment: ${deployError.message}`);