Generate Artifacts Outside the Tags Context (#15)

This pull request introduces changes to improve the handling of GitHub
Actions workflows by adding support for tag-based operations and
refactoring the configuration setup. Additionally, it includes updates
to testing configurations and test cases to align with these changes.

### GitHub Actions Workflow Enhancements:
*
[`src/configuration.ts`](diffhunk://#diff-0931cf958317ce57b36bdf11695eaa9ce4ebeec0f9ae067343159a85d75732dfL7-R10):
Added a new `env` parameter to the `Configuration` class and a method
`isTag` to determine if the workflow is triggered by a tag reference.
[[1]](diffhunk://#diff-0931cf958317ce57b36bdf11695eaa9ce4ebeec0f9ae067343159a85d75732dfL7-R10)
[[2]](diffhunk://#diff-0931cf958317ce57b36bdf11695eaa9ce4ebeec0f9ae067343159a85d75732dfR19-R22)
*
[`src/main.ts`](diffhunk://#diff-4fab5baaca5c14d2de62d8d2fceef376ddddcc8e9509d86cfa5643f51b89ce3dL9-R20):
Updated the `main` function to conditionally execute temporary branch
creation and deletion based on the `isTag` property.
*
[`src/model/artifacts.ts`](diffhunk://#diff-5595f77bb2b2f49522043f8dcd486390018618b047f219418459269c756ecc03L19-R21):
Modified the `Artifacts` class to conditionally execute tag-related
tasks (`collect` and `move`) based on the `isTag` property.

### Testing Updates:
*
[`tests/unit/model/artifacts.test.ts`](diffhunk://#diff-7038a68cfc252210ef35773ee922184899920f50ea4663f60096442511db507eR138-R180):
Added a new test case to verify that tag-related tasks are skipped when
the action is not triggered by a tag. Updated the `configuration`
function to accept an optional `env` parameter for testing purposes.

### Configuration and File Structure Adjustments:
*
[`jest.config.ts`](diffhunk://#diff-860bd1f15d1e0bafcfc6f62560524f588e6d6bf56d4ab1b0f6f8146461558730L7-R10):
Updated paths in `moduleNameMapper` and `setupFilesAfterEnv` to reflect
the new file structure after renaming `tests/jest.config.ts` to
`jest.config.ts`.
*
[`package.json`](diffhunk://#diff-7ae45ad102eab3b6d7e7896acd08c427a9b25b346470d7bc6507b6481575d519L33-R33):
Simplified the Jest configuration in the `test` script to use the
default `jest.config.ts`.
*
[`tests/tsconfig.json`](diffhunk://#diff-9ef891bf14629264f353ee51ca7dad4267563a5d90ad7e3c62030eba140bf5c9L12-R12):
Adjusted the `include` paths to match the updated file structure.

Author: widoz

dist/index.js

@@ -4,9 +4,9 @@ module.exports = {
   preset: 'ts-jest',
   moduleDirectories: ['node_modules'],
   moduleNameMapper: {
-    '^@/(.*)$': '<rootDir>/../src/$1',
-    '^@model/(.*)$': '<rootDir>/../src/model/$1',
+    '^@/(.*)$': '<rootDir>/src/$1',
+    '^@model/(.*)$': '<rootDir>/src/model/$1',
   },
-  setupFilesAfterEnv: ['<rootDir>/setup-tests.ts'],
+  setupFilesAfterEnv: ['<rootDir>/tests/setup-tests.ts'],
   maxWorkers: 8,
 };

tests/jest.config.ts jest.config.tstests/jest.config.ts renamed to jest.config.ts

@@ -30,7 +30,7 @@
     "lint": "eslint ./src --ext .ts",
     "lint:test": "eslint --config ./tests/.eslintrc.json ./tests --ext .ts",
     "prepare": "husky",
-    "test": "jest --config ./tests/jest.config.ts",
+    "test": "jest",
     "qa": "yarn lint && yarn lint:test && yarn test"
   }
 }

package.json

@@ -4,7 +4,10 @@ export class Configuration {
   private static readonly COMMAND = 'yarn build';
   private static readonly TARGET_DIR = './build';
 
-  constructor(private readonly read: typeof getInput) {}
+  constructor(
+    private readonly read: typeof getInput,
+    private readonly env: Readonly<NodeJS.ProcessEnv>
+  ) {}
 
   public get command(): string {
     return this.read('command') || Configuration.COMMAND;
@@ -13,4 +16,8 @@ export class Configuration {
   public get targetDir(): string {
     return this.read('target-dir') || Configuration.TARGET_DIR;
   }
+
+  public get isTag(): boolean {
+    return (this.env['GITHUB_REF'] ?? '').startsWith('refs/tags/');
+  }
 }

src/configuration.ts

@@ -6,17 +6,18 @@ import { createGit } from './create-git';
 import { Configuration } from './configuration';
 
 async function main(): Promise<void> {
-  const configuration = new Configuration(core.getInput.bind(core));
+  const configuration = new Configuration(core.getInput.bind(core), process.env);
 
   const git = await createGit();
   const tags = new Tags(git);
   const artifacts = new Artifacts(git, tags, configuration);
   const temporaryBranch = new TemporaryBranch(git);
+  const { isTag } = configuration;
 
   Promise.resolve()
-    .then(() => temporaryBranch.create())
+    .then(() => (isTag ? temporaryBranch.create() : null))
     .then(() => artifacts.update())
-    .then(() => temporaryBranch.delete())
+    .then(() => (isTag ? temporaryBranch.delete() : null))
 
     .catch((error) => {
       core.setFailed(`Failed to create and push artifacts: ${error}`);

src/main.ts

@@ -16,9 +16,9 @@ export class Artifacts {
 
     try {
       await this.compile();
-      await this.tags.collect();
+      this.configuration.isTag && (await this.tags.collect());
       await this.deploy();
-      await this.tags.move();
+      this.configuration.isTag && (await this.tags.move());
     } catch (error: unknown) {
       core.endGroup();
       const message = String(error instanceof Error ? error.message : error);

src/model/artifacts.ts

@@ -9,6 +9,6 @@
     },
     "rootDir": "./"
   },
-  "include": ["../src/**/*.ts", "./unit/**/*.ts", "jest.config.ts", "setup-tests.ts"],
+  "include": ["../src/**/*.ts", "./unit/**/*.ts", "../jest.config.ts", "setup-tests.ts"],
   "exclude": ["../node_modules"]
 }

tests/tsconfig.json

@@ -135,10 +135,49 @@ describe('Artifacts', () => {
 
     expect(collect.mock.invocationCallOrder[0]).toBeLessThan(move.mock.invocationCallOrder[0] ?? 0);
   });
+
+  it('Do not perform any tasks associated to tags when the action is not running for tags', async () => {
+    const git = fromPartial<SimpleGit>({
+      commit: jest.fn(() =>
+        Promise.resolve({ summary: { changes: 0, insertions: 0, deletions: 0 } })
+      ),
+      push: jest.fn(() =>
+        Promise.resolve({
+          remoteMessages: {
+            all: [''],
+          },
+        })
+      ),
+    });
+
+    const collect = jest.fn();
+    const move = jest.fn();
+    const tags = fromPartial<Tags>({ collect, move });
+
+    const _configuration = configuration({
+      GITHUB_REF: 'refs/heads/main',
+    });
+    const artifacts = new Artifacts(git, tags, _configuration);
+
+    jest.mocked(exec).mockImplementation(async () => Promise.resolve(0));
+
+    await artifacts.update();
+
+    expect(collect).not.toHaveBeenCalled();
+    expect(move).not.toHaveBeenCalled();
+  });
 });
 
-function configuration(): Configuration {
-  return new Configuration(stubGetInput());
+function configuration(env?: Readonly<NodeJS.ProcessEnv>): Configuration {
+  let _env = env;
+
+  if (!_env) {
+    _env = {
+      GITHUB_REF: 'refs/tags/v1.0.0',
+    };
+  }
+
+  return new Configuration(stubGetInput(), _env);
 }
 
 function stubGetInput(): typeof getInput {