Refined github action with proper parameter passing.

ivanmilevtues · ivanmilevtues · commit 297db07c70d0 · 2025-06-23T02:43:01.000+02:00
diff --git a/.github/workflows/example-usage.yml b/.github/workflows/example-usage.yml
@@ -3,11 +3,34 @@ name: Example Usage of CodeBoarding Action
 on:
   workflow_dispatch:
     inputs:
-      test_repo:
+      repository_url:
         description: 'Repository URL to test with'
         required: false
-        default: 'https://github.com/CodeBoarding/insights-core'
+        default: 'https://github.com/microsoft/markitdown'
         type: string
+      source_branch:
+        description: 'Source branch for comparison'
+        required: false
+        default: 'main'
+        type: string
+      target_branch:
+        description: 'Target branch for comparison'
+        required: false
+        default: 'develop'
+        type: string
+      output_format:
+        description: 'Output format for documentation'
+        required: false
+        default: '.md'
+        type: choice
+        options:
+          - '.md'
+          - '.rst'
+  
+  pull_request:
+    branches: [ main, master ]
+    types: [opened, synchronize, reopened]
+  
   schedule:
     # Run daily at 2 AM UTC
     - cron: '0 2 * * *'
@@ -24,22 +47,54 @@ jobs:
         uses: actions/checkout@v4
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
+          fetch-depth: 0  # Required to access branch history
+
+      # Determine branches based on context
+      - name: Set branch variables
+        id: set-branches
+        run: |
+          if [ "${{ github.event_name }}" = "pull_request" ]; then
+            echo "source_branch=${{ github.head_ref }}" >> $GITHUB_OUTPUT
+            echo "target_branch=${{ github.base_ref }}" >> $GITHUB_OUTPUT
+          elif [ "${{ github.event.inputs.source_branch }}" != "" ] && [ "${{ github.event.inputs.target_branch }}" != "" ]; then
+            echo "source_branch=${{ github.event.inputs.source_branch }}" >> $GITHUB_OUTPUT
+            echo "target_branch=${{ github.event.inputs.target_branch }}" >> $GITHUB_OUTPUT
+          else
+            # Default to current branch and main
+            echo "source_branch=${{ github.ref_name }}" >> $GITHUB_OUTPUT
+            echo "target_branch=main" >> $GITHUB_OUTPUT
+          fi
 
       - name: Fetch CodeBoarding Documentation
         id: codeboarding
-        uses: ./  # Use the local action (when this is published, users would use: owner/repo@version)
+        uses: ./
         with:
-          repository_url: ${{ github.repository }}
-          output_directory: '.codeboarding'
+          repository_url: ${{ github.event.inputs.repository_url }}
+          source_branch: ${{ steps.set-branches.outputs.source_branch }}
+          target_branch: ${{ steps.set-branches.outputs.target_branch }}
+          output_directory: 'docs'
+          output_format: ${{ github.event.inputs.output_format || '.md' }}
 
       - name: Display Action Results
         run: |
-          echo "Files created: ${{ steps.codeboarding.outputs.files_created }}"
-          echo "Output directory: ${{ steps.codeboarding.outputs.output_directory }}"
+          echo "Documentation files created: ${{ steps.codeboarding.outputs.markdown_files_created }}"
+          echo "JSON files created: ${{ steps.codeboarding.outputs.json_files_created }}"
+          echo "Documentation directory: ${{ steps.codeboarding.outputs.output_directory }}"
+          echo "JSON directory: ${{ steps.codeboarding.outputs.json_directory }}"
           echo "Has changes: ${{ steps.codeboarding.outputs.has_changes }}"
 
+      # Check if we have any changes to commit
+      - name: Check for changes
+        id: git-changes
+        run: |
+          if [ -n "$(git status --porcelain)" ]; then
+            echo "has_git_changes=true" >> $GITHUB_OUTPUT
+          else
+            echo "has_git_changes=false" >> $GITHUB_OUTPUT
+          fi
+
       - name: Create Pull Request
-        if: steps.git-changes.outputs.has_git_changes == 'true'
+        if: steps.git-changes.outputs.has_git_changes == 'true' && steps.codeboarding.outputs.has_changes == 'true'
         uses: peter-evans/create-pull-request@v5
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
@@ -51,17 +106,21 @@ jobs:
             This PR contains updated documentation files fetched from the CodeBoarding service.
             
             ### 📊 Summary
-            - **Files created/updated**: ${{ steps.codeboarding.outputs.files_created }}
-            - **Output directory**: `${{ steps.codeboarding.outputs.output_directory }}/`
-            - **Source endpoint**: ${{ vars.CODEBOARDING_ENDPOINT || 'codeboarding endpoint' }}
-            - **Repository analyzed**: ${{ github.event.inputs.test_repo || github.repository }}
+            - **Documentation files created/updated**: ${{ steps.codeboarding.outputs.markdown_files_created }}
+            - **JSON files created/updated**: ${{ steps.codeboarding.outputs.json_files_created }}
+            - **Documentation directory**: `${{ steps.codeboarding.outputs.output_directory }}/`
+            - **JSON directory**: `${{ steps.codeboarding.outputs.json_directory }}/`
+            - **Source branch**: `${{ steps.set-branches.outputs.source_branch }}`
+            - **Target branch**: `${{ steps.set-branches.outputs.target_branch }}`
+            - **Output format**: `${{ github.event.inputs.output_format || '.md' }}`
+            - **Repository analyzed**: `${{ steps.codeboarding.outputs.repo_url }}`
             
             ### 🔍 Changes
-            Files have been updated in the `${{ steps.codeboarding.outputs.output_directory }}/` directory with fresh documentation content.
+            Files have been updated with fresh documentation content based on code changes between branches.
             
             ---
             
             🤖 This PR was automatically generated by the CodeBoarding documentation update workflow.
           branch: docs/codeboarding-update
-          base: main
+          base: ${{ steps.set-branches.outputs.target_branch }}
           delete-branch: true
diff --git a/README.md b/README.md
@@ -17,42 +17,65 @@ on:
     branches: [ main ]
   pull_request:
     branches: [ main ]
+    types: [opened, synchronize, reopened]
 
 jobs:
   documentation:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Required to access branch history
         
       - name: Generate Documentation
-        uses: your-username/CodeBoarding-GHAction@v1
+        uses: codeboarding/codeboarding-ghaction@v1
         with:
           repository_url: ${{ github.server_url }}/${{ github.repository }}
-          output_directory: '.codeboarding'
+          source_branch: ${{ github.head_ref || github.ref_name }}
+          target_branch: ${{ github.base_ref || 'main' }}
+          output_directory: 'docs'
+          output_format: '.md'
           
       - name: Upload Documentation
         uses: actions/upload-artifact@v4
         with:
           name: documentation
-          path: .codeboarding/
+          path: |
+            docs/
+            .codeboarding/
 ```
 
 ## Inputs
 
 | Input | Description | Required | Default |
 |-------|-------------|----------|---------|
 | `repository_url` | Repository URL for which documentation will be generated | Yes | - |
-| `output_directory` | Directory where documentation files will be saved | No | `.codeboarding` |
+| `source_branch` | Source branch for comparison (typically the PR branch) | Yes | - |
+| `target_branch` | Target branch for comparison (typically the base branch) | Yes | - |
+| `output_directory` | Directory where documentation files will be saved | No | `docs` |
+| `output_format` | Format for documentation files (either `.md` or `.rst`) | No | `.md` |
 
 ## Outputs
 
 | Output | Description |
 |--------|-------------|
-| `files_created` | Number of files created |
-| `output_directory` | Directory where files were saved |
+| `markdown_files_created` | Number of documentation files created |
+| `json_files_created` | Number of JSON files created |
+| `output_directory` | Directory where documentation files were saved |
+| `json_directory` | Directory where JSON files were saved (always `.codeboarding`) |
 | `has_changes` | Whether any files were created or changed |
 
+## How It Works
+
+The action works by:
+
+1. Analyzing the differences introduced in the source branch and putting the results in the target branch
+2. Generating documentation files based on the latest version of the source branch
+3. Outputting two types of files:
+   - Documentation files (Markdown or RST) in the specified output directory
+   - Metadata files in the `.codeboarding` directory
+
 ## License
 
 MIT License - see [LICENSE](LICENSE) file for details.
diff --git a/action.yml b/action.yml
@@ -41,6 +41,9 @@ outputs:
   has_changes:
     description: 'Whether any files were created or changed'
     value: ${{ steps.process-docs.outputs.has_changes }}
+  repo_url:
+    description: 'Repository URL that was analyzed'
+    value: ${{ steps.repo-url.outputs.repo_url }}
 
 runs:
   using: 'composite'
@@ -49,20 +52,29 @@ runs:
       id: repo-url
       shell: bash
       run: |
-        if [ "${{ inputs.repository_url }}" != "" ]; then
+        # Use the provided repository URL if it's not empty
+        if [ -n "${{ inputs.repository_url }}" ]; then
           REPO_URL="${{ inputs.repository_url }}"
           echo "Using provided repository URL: $REPO_URL"
+        # Otherwise try to determine from git if we're in a git repository
+        elif git config --get remote.origin.url > /dev/null 2>&1; then
+          REPO_URL=$(git config --get remote.origin.url)
+          # Convert SSH URL to HTTPS if needed
+          if [[ $REPO_URL == git@* ]]; then
+            REPO_URL=$(echo $REPO_URL | sed 's|git@github.com:|https://github.com/|')
+          fi
+          echo "Using git remote URL: $REPO_URL"
         else
           REPO_URL="${{ github.server_url }}/${{ github.repository }}"
-          echo "Using current repository URL: $REPO_URL"
+          echo "Using GitHub context URL: $REPO_URL"
         fi
         echo "repo_url=$REPO_URL" >> $GITHUB_OUTPUT
 
     - name: Fetch documentation files
       id: fetch-docs
       shell: bash
       run: |
-        ENDPOINT_URL="https://server.codeboarding.org/github_action"
+        ENDPOINT_URL="http://0.0.0.0:8000/github_action"
         REPO_URL="${{ steps.repo-url.outputs.repo_url }}"
         SOURCE_BRANCH="${{ inputs.source_branch }}"
         TARGET_BRANCH="${{ inputs.target_branch }}"
