Commit Graph

14 Commits

Author SHA1 Message Date
5277f93df1 Disable console errors and enhance docs generation
Updated ESLint rules to turn off 'no-console' to allow console statements. Streamlined the GitHub Actions workflow to combine test coverage and TypeDoc generation into a single script for more efficient documentation deployment. Enhanced README with simplified test coverage badges. Added new npm scripts to automate documentation fixes, including a script to correct escaping issues in HTML files. Improved documentation generation, ensuring comprehensive and accurate project documentation.
2024-08-16 16:10:14 +02:00
7258f3813f Update test script in DeployTypeDoc workflow
Modified the GitHub Actions DeployTypeDoc workflow to run `npm run test:coverage` instead of `npm run test:verbose`. This change switches from verbose test output to generating test coverage, aiming to improve code quality insights during deployment.
2024-08-16 12:04:47 +02:00
187b39e7c5 Add GitHub Actions workflow for TypeDoc deployment
Introduced a new GitHub Actions workflow to automate the deployment of documentation using TypeDoc and test coverage to GitHub Pages. The workflow triggers on pushes to the main branch or manually. Steps include checking out the repository, setting up Node.js, installing dependencies, running tests, generating TypeDoc documentation, and deploying the output to the gh-pages branch.
2024-08-16 11:40:24 +02:00
f0d1db6fa1 Upgrade package versions and update ESLint config
Upgraded the project version to 0.0.8. Updated various dev dependencies, specifically @typescript-eslint packages and eslint-plugin-jsdoc, to their latest versions. Replaced @typescript-eslint/eslint-plugin with @stylistic/eslint-plugin to ensure compatibility and improved linting. These changes enhance code quality and tool efficiency.
2024-08-15 00:08:52 +02:00
ad4a8fd8c6 Include additional files in release and mark as prerelease
Added `src` folder and `tsconfig.json` to the release preparation to ensure all necessary files are included. Uncommented the deletion of the temporary branch to streamline the workflow. Set releases to be marked as prereleases automatically. Updated version in `package.json` to 0.0.5 and included a `files` field to specify which files to include in the package.
2024-08-14 22:34:15 +02:00
f56df7eb29 Comment out temporary branch deletion in workflow
### Details
Disabled the step for deleting the temporary branch in the release workflow by commenting out the relevant lines. This adjustment prevents potential issues caused by branch deletion during the release process and ensures the stability of the workflow until a more robust solution is implemented.
2024-08-14 21:50:12 +02:00
8937d5f307 Configure Git user in release workflow
Added steps to set the Git user name and email in the release workflow. This ensures that commits made by the workflow are correctly attributed to GitHub Actions, preventing potential issues with commit authorship.
2024-08-14 21:48:13 +02:00
27ed151589 Improve CreateRelease workflow cleanup
Updated the GitHub Actions CreateRelease workflow to use `git reset` instead of `git rm -rf`, ensuring the `.gitignore` file is removed. Simplifies the preparation of files for release and prevents the removal of unexpected files.
2024-08-14 21:46:58 +02:00
1606c9b6dd Refine create_temp_branch logic in release workflow
Switched `git reset --hard` to `git rm -rf .` followed by a target-specific `git reset` in the release workflow. This change ensures only the necessary files (README.md, package.json, LICENSE, dist/**) are retained for the temp release branch, improving the accuracy of release preparation.
2024-08-14 21:43:38 +02:00
f7dc771e0a Automate release workflow, bump version to 0.0.3
Added the creation of a temporary branch to stage release files before tagging, ensuring a clean release environment. Adjusted the tag creation process and included steps to delete the temporary branch post-tagging. Updated `package.json` to version 0.0.3 and set module type for better compatibility.
2024-08-14 21:22:06 +02:00
8d607c7f0c Change exit code for unchanged version condition
Modified the workflow to exit with code 1 instead of 0 when the version has not changed. This prevents the release job from being considered successful when no new release is created, improving the accuracy of pipeline status.
2024-08-14 20:02:33 +02:00
587918136e Disable file uploads in release action
Commented out the file uploads section in the CreateRelease GitHub Action workflow. This prevents specified files from being included in the release, likely streamlining the release process or addressing issues with file attachments.
2024-08-14 19:58:49 +02:00
079249aa3c Add automated release workflow and update configs
Introduced a GitHub Actions workflow to automate release creation upon pushes to the main branch, enhancing CI/CD efficiency. Updated the pull request workflow to support manual triggers. Adjusted Jest's coverage thresholds from 80% to 70% to reflect current testing standards. Added "types" field in package.json for TypeScript declarations. Created an empty README.md.
2024-08-14 19:53:09 +02:00
1341427590 Basic setup of the project. 2024-08-14 19:40:05 +02:00