Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure Action Repository #327

Merged
merged 6 commits into from
Feb 12, 2025
Merged

Restructure Action Repository #327

merged 6 commits into from
Feb 12, 2025

Conversation

ncalteen
Copy link
Contributor

This pull request includes several changes to configuration files, the addition of new workflows, and updates to existing workflows. The most important changes are summarized below:

Configuration changes:

  • Removed .editorconfig, .eslintignore, .eslintrc.json, .husky/pre-commit, .prettierignore, and .prettierrc.json files. [1] [2] [3] [4] [5] [6]
  • Added .gitattributes to manage end-of-line settings and mark certain directories as generated.
  • Updated .env.example with new environment variables and guidelines for using @github/local-action to run this action locally.

GitHub Actions workflows:

  • Added new workflows for continuous integration, continuous delivery, linting, and CodeQL analysis. [1] [2] [3] [4]
  • Added a workflow to check the dist/ directory for expected transpiled code.

Other changes:

  • Updated .github/dependabot.yml to group dependency updates and change the update interval to weekly.
  • Added .markdown-lint.yml to configure markdown linting rules.
  • Added .node-version to specify the Node.js version used in the project.
  • Added .vscode/launch.json to configure debugging settings for the project in Visual Studio Code.
  • Upgraded ESLint and associated configuration files to v9+
  • Added 100% test coverage
  • Moved required environment variables to action inputs
  • Switched from @vercel/ncc to rollup for packaging

@ncalteen ncalteen requested review from lindluni and Copilot February 12, 2025 20:33
@ncalteen ncalteen self-assigned this Feb 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Overview

This pull request restructures the action repository by removing obsolete configuration files, adding new GitHub Actions workflows, and updating related configurations. Key changes include:

  • Removal of various code style and formatting configuration files.
  • Addition of workflows for continuous integration, continuous delivery, linting, CodeQL analysis, and a check to verify the transpiled code in dist/.
  • Updates to dependabot, markdown linting, and prettierrc configurations to streamline development and deployment.

Changes

File Description
.github/workflows/continuous-integration.yml New CI workflow that checks out the code, sets up Node.js, installs dependencies, runs format checks, linting, and tests.
.github/workflows/check-dist.yml Workflow ensuring that the transpiled code in the dist/ directory matches the expected build outputs.
.github/workflows/continuous-delivery.yml Workflow that creates a Git tag and a release when a pull request is closed with a merge on main.
.github/workflows/linter.yml Workflow to check the full codebase using Super Linter against updated branch & push events.
.github/workflows/codeql.yml Workflow to perform security analysis using CodeQL.
.prettierrc.yml Configuration file for Prettier.
.markdown-lint.yml Markdown linting rules configuration.
.github/dependabot.yml Updated dependabot configuration with adjusted schedule and dependency groups.
.github/codeql/codeql-config.yml Configuration to ignore certain paths (e.g., node_modules and dist) for CodeQL analysis.

Copilot reviewed 58 out of 58 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (1)

.github/workflows/check-dist.yml:66

  • [nitpick] The conditional expression using failure() together with steps.diff.outcome may not behave as expected; consider revising the condition to directly check if steps.diff.outcome equals 'failure' if that is the intended trigger.
      - if: ${{ failure() && steps.diff.outcome == 'failure' }}

Tip: Turn on automatic Copilot reviews for this repository to get quick feedback on every pull request. Learn more

@ncalteen ncalteen merged commit f62d234 into main Feb 12, 2025
17 checks passed
@ncalteen ncalteen deleted the ncalteen/restructure branch February 12, 2025 20:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants