Merge pull request k3s-io#487 from axivo/feature/workflow-improvements

feat: workflow improvements

Author: fmunteanu

.github/workflows/documentation.yml

@@ -19,14 +19,14 @@ permissions:
   contents: write
 
 jobs:
-  build:
-    name: Build Documentation
+  update:
+    name: Update Documentation
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout code
+      - name: Checkout repository
         uses: actions/checkout@v4
 
-      - name: Install package
+      - name: Install helm-docs package
         env:
           HELM_DOCS_URL: https://github.com/norwoodj/helm-docs/releases/download
           HELM_DOCS_VERSION: 1.14.2
@@ -35,36 +35,27 @@ jobs:
           script: |
             const os = require('os');
             const tmpDir = os.tmpdir();
-            const helmDocsPath = [tmpDir,
+            const packagePath = [tmpDir,
               'helm-docs_' + process.env.HELM_DOCS_VERSION + '_Linux_x86_64.deb'
             ].join('/');
-            const helmDocsUrl = [process.env.HELM_DOCS_URL, 'v' + process.env.HELM_DOCS_VERSION,
+            const packageUrl = [process.env.HELM_DOCS_URL, 'v' + process.env.HELM_DOCS_VERSION,
               'helm-docs_' + process.env.HELM_DOCS_VERSION + '_Linux_x86_64.deb'
             ].join('/');
             const runSudo = async (args) => (await exec.exec('sudo', args));
             try {
-              await runSudo(['wget', '-qP', tmpDir, helmDocsUrl]);
-              await runSudo(['apt-get', '-y', 'install', helmDocsPath]);
+              await runSudo(['wget', '-qP', tmpDir, packageUrl]);
+              await runSudo(['apt-get', '-y', 'install', packagePath]);
             } catch (error) {
               core.setFailed(error.message);
             }
 
       - name: Update documentation
-        id: update
         uses: actions/github-script@v7
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |
+            const fs = require('fs/promises');
             const runGit = async (args) => (await exec.getExecOutput('git', args)).stdout.trim();
-            const excludeList = async () =>
-              (await runGit(['ls-files', '-d', '--deduplicate', '--exclude-standard'])).trim().split('\n');
-            const processFiles = async (flag, label, exclusions) => {
-              const files = (await runGit(['ls-files', '-' + flag, '--deduplicate', '--exclude-standard']))
-                .split('\n')
-                .filter(file => file && (flag === 'om' && !exclusions.includes(file)));
-              core.setOutput(label, files.join(','));
-              return files.length;
-            };
             try {
               await Promise.all([
                 runGit(['config', 'user.name', 'github-actions[bot]']),
@@ -73,47 +64,45 @@ jobs:
               await runGit(['fetch', 'origin', process.env.GITHUB_HEAD_REF]);
               await runGit(['switch', process.env.GITHUB_HEAD_REF]);
               await exec.exec('helm-docs', ['-f', './defaults/main.yaml']);
-              const exclusions = await excludeList();
-              const [additions, deletions] = await Promise.all([
-                processFiles('om', 'additions', exclusions),
-                processFiles('d', 'deletions', exclusions)
-              ]);
-            } catch (error) {
-              core.setFailed(error.message);
-            }
-
-      - name: Create commit
-        if: steps.update.outputs.additions || steps.update.outputs.deletions
-        uses: actions/github-script@v7
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          script: |
-            const fs = require('fs/promises');
-            const parseFiles = async (files, type) =>
-              Promise.all(files.split(',').filter(Boolean).map(async file => (type === 'add')
-                ? { path: file, contents: Buffer.from(await fs.readFile(file, 'utf-8')).toString('base64') }
-                : { path: file }
-              ));
-            const input = {
-              branch: {
-                repositoryNameWithOwner: context.payload.repository.full_name,
-                branchName: context.payload.pull_request.head.ref
-              },
-              expectedHeadOid: context.payload.pull_request.head.sha,
-              fileChanges: {
-                additions: await parseFiles('${{ steps.update.outputs.additions }}', 'add'),
-                deletions: await parseFiles('${{ steps.update.outputs.deletions }}', 'delete')
-              },
-              message: { headline: 'docs(github-action): update documentation' }
-            };
-            const mutation = `
-              mutation CreateCommitOnBranch($input: CreateCommitOnBranchInput!) {
-                createCommitOnBranch(input: $input) { commit { oid } }
+              const files = (await runGit(['diff', '--name-only'])).split('\n').filter(Boolean);
+              if (files.length === 0) {
+                core.info('No file changes detected');
+                return;
               }
-            `;
-            try {
+              const additions = await Promise.all((await runGit(['diff', '--name-only', '--diff-filter=ACMR']))
+                .split('\n')
+                .filter(Boolean)
+                .map(async file => {
+                  const contents = await fs.readFile(file, 'utf-8');
+                  return {
+                    path: file,
+                    contents: Buffer.from(contents).toString('base64')
+                  };
+                })
+              );
+              const deletions = (await runGit(['diff', '--name-only', '--diff-filter=D']))
+                .split('\n')
+                .filter(Boolean)
+                .map(file => ({ path: file }));
+              const input = {
+                branch: {
+                  repositoryNameWithOwner: context.payload.repository.full_name,
+                  branchName: context.payload.pull_request.head.ref
+                },
+                expectedHeadOid: context.payload.pull_request.head.sha,
+                fileChanges: {
+                  additions: additions,
+                  deletions: deletions
+                },
+                message: { headline: 'docs(github-action): update documentation' }
+              };
+              const mutation = `
+                mutation CreateCommitOnBranch($input: CreateCommitOnBranchInput!) {
+                  createCommitOnBranch(input: $input) { commit { oid } }
+                }
+              `;
               const { createCommitOnBranch } = await github.graphql(mutation, { input });
-              console.log('Commit created with OID:', createCommitOnBranch.commit.oid);
+              core.info('Signed commit created with OID:', createCommitOnBranch.commit.oid);
             } catch (error) {
               core.setFailed(error.message);
             }