Skip to content

Update workflows, documentation, and dependency configuration #120

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

Merged
merged 19 commits into from
Apr 11, 2025
Merged

Conversation

thevuong
Copy link
Contributor

Description

This pull request includes several updates and enhancements to workflows, documentation, and dependency management:

  • Workflows:

    • Introduced split release workflows for canary and production to streamline release flow.
    • Enhanced permissions in the deploy workflow for better interaction with GitHub issues and pull requests.
    • Improved pre-release management for canary builds.
    • Refined cache key configurations and updated path triggers for workflows to increase efficiency and consistency.
  • Documentation:

    • Updated SECURITY.md with supported version policies and clear vulnerability reporting guidelines.
    • Simplified version badge details in the README to make ongoing maintenance easier.
  • Dependencies:

    • Bumped the @swc/core dependency to the latest compatible version (^1.11.20).
    • Improved NPM authentication logic in CI workflows for better maintainability and efficiency.

thevuong and others added 19 commits April 11, 2025 11:38
Removed unnecessary path filters from the deployment workflow configuration. This change ensures the workflow triggers consistently on changes to relevant branches or pull requests without redundant restrictions.
Added commands to log the home directory paths during the release workflow. This can help in debugging and verifying the environment setup for NPM authentication.
Updated NPM authentication log messages for clarity in `release.yml`. Adjusted deployment workflow triggers to include specific file paths for improved precision in `deploy.yml`.
Added path filters to the release workflow for better control over triggering conditions. Updated NPM authentication step to use the HOME environment variable directly, ensuring compatibility and clarity.
Adjusted the paths section of the release workflow to ensure proper triggering. This change re-adds a previously removed path pattern for package-related files.
Reordered the paths in the workflow triggers to ensure proper evaluation and consistency. This change addresses potential mismatches in path priorities, improving deployment behavior for both push and pull requests.
Replaced `${{ HOME }}` with `$HOME` to correct the syntax in the release workflow file. This ensures proper evaluation and avoids potential issues with environment variable resolution during execution.
Added a step in the setup-environment action to configure the NPM auth token automatically, removing the redundant manual authentication step in the release workflow. This simplifies the CI pipeline and centralizes the configuration for better maintainability.
The NPM_TOKEN environment variable has been commented out in the release workflow. This change prevents its usage during the setup of the CI environment while keeping the configuration for potential future reactivation.
Simplifies the setup-environment action by removing npm registry URL and auth token configuration. The workflow no longer relies on passing the NPM_TOKEN, streamlining the process and reducing complexity. This cleanup removes unused inputs and ensures a more straightforward configuration.
Updated @swc/core devDependency across multiple packages to ^1.11.20 for consistency and to incorporate the latest improvements and fixes. This change ensures alignment with the latest supported version of the SWC compiler.
Updated the Turbo cache key to include `pnpm-lock.yaml` hash, branch name, and commit SHA for improved cache precision. Added multiple restore key fallbacks to enhance cache retrieval and reduce redundant builds.
Introduce steps to enter and exit canary pre-release mode based on branch. Allows managing pre-releases on "canary" and finalizing them on "main". Ensures better release flow handling with changesets.
Added permissions for workflows, configured git user for CI, and improved canary pre-release handling. Integrated changesets action for canary and main branches, syncing main to canary after releases. Updated environment variables for Turbo and adjusted build and publish steps for efficiency.
Introduced separate workflows for canary and production releases to improve clarity and control. Canary releases now only trigger on the `canary` branch, while production releases occur on the `main` branch. Added a new sync workflow to merge `main` into `canary` post-production release.
Added necessary permissions to the deploy workflow to allow reading repository contents and creating comments on issues and pull requests. This ensures the workflow runs smoothly while interacting with PRs and issues.
Revised supported versions to reflect current project status. Added clear instructions for reporting vulnerabilities, including response timelines and remediation procedures. Emphasized commitment to user security and outlined contributor acknowledgment process.
Updated the version numbers in README badges for Next.js, TypeScript, Radix UI, and Tailwind CSS to be less specific. This reduces unnecessary detail and makes the README easier to maintain.
@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

Copy link
Contributor

🚀 Preview deployment is ready!

🔍 Preview URL: https://codefast-kbtksrtuf-codefastlabs.vercel.app

@thevuong thevuong merged commit 9458712 into main Apr 11, 2025
4 checks passed
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.

1 participant