Merge pull request #1 from hanseartic/include-readme-into-js-action-tags

Adds readme to js-action's glob

Author: teunmooij

src/glob-patterns.ts

@@ -3,8 +3,8 @@ import fs from 'node:fs';
 import type { Arguments } from './types';
 
 const templates: Record<string, string[]> = {
-  'composite-action': ['action.{yml,yaml}', 'LICENSE'],
-  'javascript-action': ['action.{yml,yaml}', 'dist/**', 'LICENSE'],
+  'composite-action': ['action.{yml,yaml}', 'LICENSE', 'README{,.md}'],
+  'javascript-action': ['action.{yml,yaml}', 'dist/**', 'LICENSE', 'README{,.md}'],
 };
 
 const extractNames = (input: string) =>

test/glob-patterns.spec.ts

@@ -19,15 +19,15 @@ describe('glob patterns tests', () => {
 
       const result = getIncludePatterns(args);
 
-      expect(result).toEqual(['action.{yml,yaml}', 'LICENSE']);
+      expect(result).toEqual(['action.{yml,yaml}', 'LICENSE', 'README{,.md}']);
     });
 
     it('returns a javascript-action pattern when template is javascript-action', () => {
       const args = { template: 'javascript-action', include: '' };
 
       const result = getIncludePatterns(args);
 
-      expect(result).toEqual(['action.{yml,yaml}', 'dist/**', 'LICENSE']);
+      expect(result).toEqual(['action.{yml,yaml}', 'dist/**', 'LICENSE', 'README{,.md}']);
     });
 
     it('throws an error when an invalid template is specified', () => {
@@ -74,6 +74,7 @@ describe('glob patterns tests', () => {
         'action.{yml,yaml}',
         'dist/**',
         'LICENSE',
+        'README{,.md}',
         'README.md',
         '!src/*.ts',
       ]);