chore: add logging for debugging purpose

Author: dgrahovac

src/aws.ts

@@ -1,3 +1,4 @@
+/* eslint-disable no-console */
 import type { ReadStream } from 'fs'
 
 import type aws from 'aws-sdk'
@@ -30,6 +31,7 @@ export class AWS {
     public readonly awsS3: InstanceType<typeof aws.S3>
 
     constructor(accessKey: string, secretAccessKey: string) {
+        console.log('Initializing AWS S3...')
         this.awsS3 = new S3({
             computeChecksums: true,
             credentials: new Credentials(accessKey, secretAccessKey),
@@ -38,6 +40,8 @@ export class AWS {
     }
 
     public async deleteFile(bucket: string, pathToDelete: string) {
+        console.log('Deleting file from bucket:', bucket, 'path:', pathToDelete)
+
         return new Promise((_resolve, reject) => {
             const deleteParam = {
                 Bucket: bucket,
@@ -53,6 +57,8 @@ export class AWS {
     }
 
     public async getExistingFiles(bucket: string, prefix?: string) {
+        console.log('Getting existing files from bucket:', bucket, 'with prefix:', prefix)
+
         async function existingFilesKeys(
             s3: S3,
             param: ListObjectsV2Request,
@@ -96,6 +102,7 @@ export class AWS {
     }
 
     public async uploadFile(bucket: string, key: string, body: ReadStream, objectMimeType: string, objectACL?: ObjectCannedACL) {
+        console.log('Uploading file to bucket:', bucket, 'with key:', key, 'and mimeType:', objectMimeType)
         const uploadParams: PutObjectRequest = {
             ACL: objectACL,
             Body: body,

src/publish.ts

@@ -1,3 +1,5 @@
+/* eslint-disable no-console */
+
 import fs from 'fs'
 import * as path from 'path'
 
@@ -15,10 +17,11 @@ import type {
 
 export async function publish(config: PluginConfig, context: Context) {
     const awsConfig = AWS.loadConfig(config, context) as WithoutNullableKeys<AWSConfig>
-
+    console.log('Publish step start')
     const s3 = new AWS(awsConfig.awsAccessKey, awsConfig.awsSecretAccessKey)
 
     const filePaths = await globby(config.directoryPath)
+    console.log('Found file paths:', filePaths)
 
     let s3Bucket: string | undefined
 
@@ -36,6 +39,8 @@ export async function publish(config: PluginConfig, context: Context) {
         }
     )
 
+    console.log('S3 bucket:', s3BucketWithResolvedVariables)
+
     const [
         bucketName,
         ...bucketPrefixes
@@ -46,6 +51,7 @@ export async function publish(config: PluginConfig, context: Context) {
     })
 
     if (!bucketName) {
+        console.log('Error: Missing s3 bucket configuration.')
         throw new Error('Missing s3 bucket configuration. ' +
             'Please check your plugin configuration and add a valid ' +
             's3 bucket name or s3 bucket configuration for one or more git branches.')
@@ -97,6 +103,8 @@ export async function publish(config: PluginConfig, context: Context) {
 
     await Promise.allSettled(publishPromises)
 
+    console.log('S3 publishing successful, URL:', `https://${bucketName}.s3.amazonaws.com/${bucketPrefix}`)
+
     return {
         name: 'S3 release',
         url: `https://${bucketName}.s3.amazonaws.com/${bucketPrefix}`,

src/verifyConditions.ts

@@ -1,3 +1,5 @@
+/* eslint-disable no-console */
+
 import AggregateError from 'aggregate-error'
 import type { Context } from 'semantic-release'
 
@@ -9,6 +11,7 @@ export function verifyConditions(config: PluginConfig, context: Context): void {
     const errors = []
 
     const awsConfig = AWS.loadConfig(config, context)
+    console.log('Verify Conditions step start')
 
     if (!awsConfig.awsAccessKey) {
         errors.push(getError('ENOACCESSKEYID'))
@@ -26,6 +29,8 @@ export function verifyConditions(config: PluginConfig, context: Context): void {
         errors.push(getError('ENODIRECTORYPATH'))
     }
 
+    console.log('Errors occurred during verification:', errors)
+
     if (errors.length > 0) {
         throw new AggregateError(errors)
     }