ProteinFlow/.github/workflows/update-codeboarding-codemap.yml at 0ae64e24b87b4523fa7aae7bf9297223500494cd · adaptyvbio/ProteinFlow · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
name: ProteinFlow CodeBoarding Documentation Update

on:
  workflow_dispatch:
    inputs:
      repository_url:
        description: 'Repository URL to analyze'
        required: false
        default: 'https://github.com/adaptyvbio/ProteinFlow'
        type: string
      source_branch:
        description: 'Source branch for generation'
        required: false
        default: 'main'
        type: string
      target_branch:
        description: 'Target branch for pull request'
        required: false
        default: 'main'
        type: string
      output_format:
        description: 'Output format for documentation'
        required: false
        default: '.html'
        type: choice
        options:
          - '.html'
          - '.md'
          - '.rst'
      output_directory:
        description: 'Output directory for documentation files'
        required: false
        default: '.codeboarding'
        type: string

jobs:
  update-proteinflow-docs:
    runs-on: ubuntu-latest
    timeout-minutes: 45
    permissions:
      contents: write
      pull-requests: write
    steps:
      - name: Checkout ProteinFlow repository
        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
            echo "source_branch=main" >> $GITHUB_OUTPUT
            echo "target_branch=main" >> $GITHUB_OUTPUT
          fi

      - name: Fetch CodeBoarding Documentation
        timeout-minutes: 30
        id: codeboarding
        uses: CodeBoarding/CodeBoarding-GHAction@main
        with:
          repository_url: ${{ github.event.inputs.repository_url || 'https://github.com/adaptyvbio/ProteinFlow' }}
          source_branch: ${{ steps.set-branches.outputs.source_branch }}
          target_branch: ${{ steps.set-branches.outputs.target_branch }}
          output_directory: ${{ github.event.inputs.output_directory || '.codeboarding' }}
          output_format: ${{ github.event.inputs.output_format || '.html' }}

      - name: Display ProteinFlow Documentation Results
        run: |
          echo "ProteinFlow 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 in ProteinFlow docs
        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 ProteinFlow Documentation Pull Request
        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.PAT_TOKEN }}
          commit-message: "docs: update ProteinFlow codeboarding documentation"
          title: "📚 ProteinFlow CodeBoarding Documentation Update"
          body: |
            ## 📚 ProteinFlow Documentation Update
            This PR contains updated documentation files for ProteinFlow generated by the CodeBoarding service.

            ### 📊 Summary
            - **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 }}/`
            - **Output format**: `${{ github.event.inputs.output_format || '.html' }}`
            - **Repository analyzed**: `${{ steps.codeboarding.outputs.repo_url }}`

            ### 🧬 ProteinFlow Integration
            These documentation files will be automatically integrated into the ProteinFlow documentation site
            and will appear in the CodeBoarding section of the sidebar navigation.

            🤖 This PR was automatically generated by the ProteinFlow CodeBoarding documentation update workflow.
          branch: docs/proteinflow-codeboarding-update
          base: main
          delete-branch: true