Generate changelog including cli refactor

.github/workflows/action-ci.yml

@@ -44,15 +44,22 @@ jobs:
     steps:
         - name: Run action
           id: test-action
-          uses: ynput/github-query@main
+          uses: ynput/github-query@generate-changelog
           with:
             repo: "ynput/ayon-addon-action-testing"
             date: "2024-08-20T12:03:23Z"
-            query_parameters: "body,labels,title"
+            query_parameters: "body,labels,title,number,url,id"
+            changelog_labels: "feature,enhancement,bugfix,refactor,docs,test,pr"
 
         - name: Show results
           run: |
             echo "RAW-response: " && echo '${{ steps.test-action.outputs.raw-output }}'
             echo "Labels: " && echo '${{ steps.test-action.outputs.label-list }}'
             echo "Bump-increment: " && echo '${{ steps.test-action.outputs.bump-increment }}'
-            # echo "Changelog: " && echo '${{ steps.test-action.outputs.changelog-markdown }}'
+            echo "Changelog: " && echo '${{ steps.test-action.outputs.changelog-markdown }}'
+
+
+        - name: Show changelog formatted
+          shell: bash
+          run: |
+            printf '${{ steps.test-action.outputs.changelog-markdown }}'

README.md

@@ -1,5 +1,53 @@
-# CI-Status
+# Github-Query
+
 [![CI-Status](https://github.com/ynput/github-query/actions/workflows/action-ci.yml/badge.svg)](https://github.com/ynput/github-query/actions/workflows/action-ci.yml)
 
-# Github-Data
-Fetch and convert certain information retrieved from github
+**This is a customized query action for Ayon-related repo-workflows.**
+
+## Purpose
+
+This action mainly queries pull request related information.
+It got a bunch of conversion going on to prepare the data for further usage. This includes
+
+* Filtering PR labels
+* Suggest version increment based on found labels
+* Preparing data structure for release information
+* Prepare a markdown formatted changelog based on PR information
+
+## Usage
+
+For details see [action.yml](https://github.com/ynput/github-query/blob/main/action.yml) file
+
+```yaml
+- name: Query PR data
+  uses: ynput/github-query@main
+  with:
+    # Repository name with owner. For example, actions/checkout
+    repo: ""
+    # Date-Time-Stamp as a starting point for the query, will only process merged PRs newer then that date
+    # format: "2024-08-20T12:03:23Z"
+    date: ""
+    # JSON keys to query for in a gh query command
+    # gh pr list --state merged --search f'merged:>=<date>' --json "body,labels,title,id,number,url" --repo <repo_name>
+    query_parameters: ""
+    # Define change log content and order by this comma separated value string
+    # example: "enhancement,bugfix,docs"
+    changelog_labels: ""
+```
+
+## Outputs
+
+* raw-output - Full output json dictionary from github api
+* label-list - List of unique labels found in PRs
+* bump-increment - Increment for version bumping - either 'patch', 'minor' or 'major'
+* changelog-markdown - String containing markdown formatted release changelog
+
+## Testing
+
+Unit-test are included in `tests/` and will run on every pr targeting main and very push to main.
+These tests can be run local by changing into the `tests/` directory and running `pytest`
+
+## Developer-Hints
+
+The python file `github_query.py` calls all the main logic and provides it's function to `action.yml` through click-parameters.
+This makes the python function calls convenient to use from terminal while keeping them easy to test.

action.yml

@@ -1,12 +1,12 @@
 ---
 
-# TODO need strategy where to store defaults - which an be overriden by repo var
+# TODO need strategy where to store defaults - which an be override by repo var
 
 name: Github Release Information
 description: Fetch and convert data from github to use for a release trigger
 
 branding:
-  icon: plus
+  icon: arrow-left-circle
   color: green
 
 inputs:
@@ -19,6 +19,9 @@ inputs:
   query_parameters:
     description: Parameters to query for in pr Information
     required: true
+  changelog_labels:
+    description: CSV string of labels for changelog order
+    required: false
 
 outputs:
   raw-output:
@@ -30,9 +33,9 @@ outputs:
   bump-increment:
     description: Increment for version bumping - either `patch` or 'minor'
     value: ${{ steps.bump-increment.outputs.increment }}
-  # changelog-markdown:
-  #   description: String containing full makrdown syntax for release changelog information
-  #   value: ${{ steps.write-changelog.outputs.changelog }}
+  changelog-markdown:
+    description: String containing full markdown syntax for release changelog information
+    value: ${{ steps.write-changelog.outputs.changelog }}
 
 runs:
   using: composite
@@ -55,31 +58,35 @@ runs:
       shell: bash
       run: |
         cd $GITHUB_ACTION_PATH
-        label_list=$(python -c 'import github_query; print(github_query.get_labels(github_query.parse_args()))'  "${{ inputs.repo }}" "${{ inputs.query_parameters }}" "${{ inputs.date }}")
-        if [[ "$label_list" == '[]' ]]; then
-          echo "label_list=''" >> $GITHUB_OUTPUT
-          exit 0
-        fi
-
+        label_list=$(python github_query.py pr-labels "${{ inputs.repo }}" "${{ inputs.query_parameters }}" "${{ inputs.date }}")
+
         echo "label_list=$label_list" >> $GITHUB_OUTPUT
 
     - name: Get version increment
       id: bump-increment
       shell: bash
       run: |
         cd $GITHUB_ACTION_PATH
-        increment=$(python -c 'import github_query; pr_labels = github_query.get_labels(github_query.parse_args()); patch_repo_var = github_query.get_repo_var(repo="${{ inputs.repo }}", var_name="PATCH_BUMP_LABEL"); minor_repo_var = github_query.get_repo_var(repo="${{ inputs.repo }}", var_name="MINOR_BUMP_LABEL"); print(github_query.get_version_increment(patch_bump_list=patch_repo_var, minor_bump_list=minor_repo_var, pr_label_list=pr_labels))' "${{ inputs.repo }}" "${{ inputs.query_parameters }}" "${{ inputs.date }}")
+        increment=$(python github_query.py version-increment "${{ inputs.repo }}" "${{ inputs.query_parameters }}" "${{ inputs.date }}")
+
         echo "increment=$increment" >> $GITHUB_OUTPUT
 
-    # disabled until fixed
-    # - name: Prepare Changelog 
-    #   id: write-changelog
-    #   shell: bash
-    #   run: |
-    #     cd $GITHUB_ACTION_PATH
-    #     changelog=$(python -c 'import github_query; gh_query = github_query.parse_args(); patch_repo_var = github_query.get_repo_var(repo="${{ inputs.repo }}", var_name="PATCH_BUMP_LABEL"); minor_repo_var = github_query.get_repo_var(repo="${{ inputs.repo }}", var_name="MINOR_BUMP_LABEL"); print(github_query.prepare_changelog_markdown(pr_query=gh_query, minor_bump_list=minor_repo_var, patch_bump_list=patch_repo_var))' "${{ inputs.repo }}" "${{ inputs.query_parameters }}" "${{ inputs.date }}")
-    #     oneline_changelog=$(echo "$changelog" | base64 | tr -d '/n')
-    #     echo "oneline changelog: $oneline_changelog"
-    #     # echo "changelog=$oneline_changelog" >> $GITHUB_OUTPUT
+    # INFO multiline strings need to be precessed like this according to 
+    # INFO https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#multiline-strings
+    # INFO and
+    # INFO https://stackoverflow.com/questions/74137120/how-to-fix-or-avoid-error-unable-to-process-file-command-output-successfully/74232400#74232400
+    - name: Prepare Changelog
+      if: ${{ inputs.changelog_labels }}
+      id: write-changelog
+      shell: bash
+      run: |
+        cd $GITHUB_ACTION_PATH
+        changelog=$(python github_query.py generate-release-changelog "${{ inputs.repo }}" "${{ inputs.query_parameters }}" "${{ inputs.date }}" "${{ inputs.changelog_labels }}")
+        delimiter="$(openssl rand -hex 8)"
+        {
+          echo "changelog<<${delimiter}"
+          echo "$changelog"
+          echo "${delimiter}"
+        } >> $GITHUB_OUTPUT
 
 ...