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

Update GitHub Actions to trigger when a new version is released #283

Conversation

devleejb
Copy link
Member

@devleejb devleejb commented Aug 12, 2024

What this PR does / why we need it:

This PR updates the GitHub Actions workflow to trigger deployment actions when a new version is released, instead of immediately deploying upon a push to the main branch.

Which issue(s) this PR fixes:

Fixes #260

Special notes for your reviewer:

Previously, any push to the main branch would trigger an immediate deployment. However, with this update, the deployment process will be triggered specifically when a new version is released. This change aims to streamline deployment processes and ensure that deployments align better with version releases.

Does this PR introduce a user-facing change?:


Additional documentation:


Checklist:

  • Added relevant tests or not required
  • Didn't break anything

Summary by CodeRabbit

  • New Features
    • Introduced automated Docker image publishing upon new release events.
    • Updated GitHub Actions workflows to trigger on release events instead of push events, enhancing deployment efficiency.
  • Updates
    • Project rebranding: updated project names to "codepair-backend" and "codepair-frontend."
    • Version incremented to 0.1.0 for both backend and frontend, indicating new features or improvements.
    • Added project descriptions and author information to both backend and frontend configurations.
    • Changed licenses to Apache-2.0 for improved code sharing.

@devleejb devleejb self-assigned this Aug 12, 2024
@devleejb devleejb linked an issue Aug 12, 2024 that may be closed by this pull request
@devleejb devleejb merged commit b8b1400 into main Aug 12, 2024
3 checks passed
@devleejb devleejb deleted the 260-update-github-actions-configuration-to-support-codepair-versioning branch August 12, 2024 09:21
Copy link
Contributor

coderabbitai bot commented Aug 12, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The recent changes introduce a GitHub Actions workflow for Docker publishing and modify the deployment trigger for GitHub Pages to respond to new releases. This enhances version management and deployment clarity, ensuring that Docker images are published and the website is updated only with stable releases. Additionally, the project's metadata in both the frontend and backend package files has been updated for better branding and licensing clarity.

Changes

File Change Summary
.github/workflows/docker-publish.yaml New workflow to automate Docker publishing upon release events, including version processing.
.github/workflows/gh_pages.yaml Changed trigger from push on the main branch to release on published types for deploying GitHub Pages.
backend/package.json Updated project metadata: name, version, description, author, and license changed to Apache-2.0.
frontend/package.json Updated project metadata: name, version, description, author, and license changed to Apache-2.0.

Assessment against linked issues

Objective Addressed Explanation
Update GitHub Actions for Docker Publish and GitHub Pages ( #260 )
Align with CodePair Versioning and enhance deployment clarity ( #260 )

🐰 "With Docker's flow and pages so bright,
Our releases will launch into the night.
Metadata's fresh, and branding's anew,
CodePair shines bright, just for you!
Let's hop along with joy and cheer,
For every release, we hold so dear!" 🥕


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@coderabbitai coderabbitai bot mentioned this pull request Sep 28, 2024
2 tasks
@coderabbitai coderabbitai bot mentioned this pull request Oct 14, 2024
2 tasks
minai621 pushed a commit that referenced this pull request Nov 5, 2024
* Update `package.json` to apply version

* Add publish GitHub Actions for release

* Add jobs for cleaning version
@coderabbitai coderabbitai bot mentioned this pull request Dec 8, 2024
2 tasks
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.

Update GitHub Actions configuration to support CodePair Versioning
1 participant