Refactor CICDs

[mitch1024]

Fix and Refactor CICDs

Summary by CodeRabbit

• New Features

  • Introduced workflows for building and deploying documentation, publishing Docker images, and releasing software.
  • Added a RELEASE.md file as a placeholder for release information.

• Improvements

  • Renamed and updated steps in the unit test workflow for clarity.
  • Updated paths in the documentation Dockerfile for better organization.
  • Fixed version specifications in package.json for consistency.

• Bug Fixes

  • Removed unnecessary entries (package.json, yarn.lock) from .gitignore.

• Refactor

  • Renamed Makefile target for building binaries and removed Windows build command.

[coderabbitai]

Warning

Rate limit exceeded

@mitch1024 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 51 minutes and 25 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 2edc046 and e054531.

Walkthrough

The recent updates introduce several GitHub Actions workflows to automate documentation deployment, Docker image publishing, and software releases. The changes also include modifications to the .gitignore, Makefile, and Dockerfile to streamline the build processes. Additionally, version specifications in package.json were fixed, and a placeholder RELEASE.md was added.

Changes

Files/Paths	Change Summaries
.github/workflows/deploy-docs.yml	Added workflow for building and deploying documentation to DockerHub and GKE.
.github/workflows/publish-docker-image.yml	Added workflow for building and publishing Docker images on pushes to master and version tags.
.github/workflows/releases.yml	Added workflow for releasing software, building binaries, and publishing releases.
.github/workflows/run-unit-tests.yml	Renamed workflow and updated step names and Go setup.
.gitignore	Removed package.json and yarn.lock from ignored files.
Makefile	Renamed build target and adjusted build commands; removed newline at end of file.
RELEASE.md	Added a placeholder TODO for release information.
docs/Dockerfile	Updated file paths for copying and building documentation within Docker container.
docs/README.md	Removed a sentence about IRISnet design, focusing on its cross-chain interoperability features.
docs/package.json	Changed version specifications from caret (^) to fixed versions for @vuepress/client and @vuepress/plugin-search.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant Developer
    participant GitHub
    participant DockerHub
    participant GKE
    participant Release System
    
    Developer->>GitHub: Push changes to master or tags
    GitHub->>GitHub Actions: Trigger workflows
    GitHub Actions->>DockerHub: Build and push Docker image
    GitHub Actions->>GKE: Deploy documentation
    GitHub Actions->>Release System: Build and publish release binaries

Loading

Poem

In the land of code, where actions flow,
New workflows rise, automation grows.
Docker images built with care,
Documentation deployed everywhere.
Binaries crafted, releases shine,
A symphony of scripts, all in line.
🌟✨🐇

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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 Configration 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]

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b7c09e2 and 2edc046.

Files ignored due to path filters (2)

• docs/package-lock.json is excluded by !**/package-lock.json
• docs/yarn.lock is excluded by !**/*.lock

Files selected for processing (10)

• .github/workflows/deploy-docs.yml (1 hunks)
• .github/workflows/publish-docker-image.yml (1 hunks)
• .github/workflows/releases.yml (1 hunks)
• .github/workflows/run-unit-tests.yml (1 hunks)
• .gitignore (1 hunks)
• Makefile (2 hunks)
• RELEASE.md (1 hunks)
• docs/Dockerfile (1 hunks)
• docs/README.md (1 hunks)
• docs/package.json (1 hunks)

Files skipped from review due to trivial changes (6)

• .github/workflows/publish-docker-image.yml
• .github/workflows/run-unit-tests.yml
• .gitignore
• Makefile
• docs/README.md
• docs/package.json

Additional comments not posted (3)

docs/Dockerfile (1)

3-3: Changes in file paths and CMD instruction are appropriate.

These changes optimize the Docker build process and ensure that the nginx server is correctly configured to start.

Also applies to: 5-5, 12-12

.github/workflows/releases.yml (1)

1-31: New release workflow is well-structured and follows best practices.

The workflow is triggered appropriately, uses updated actions, and includes all necessary steps for a release process.

.github/workflows/deploy-docs.yml (1)

1-73: New documentation deployment workflow is secure and efficient.

The workflow correctly uses GitHub secrets for authentication and follows best practices for Docker and GKE deployment.

[coderabbitai]

Specify the content for release notes or detail the TODO.

Would you like assistance in drafting the initial release notes? If so, please provide some bullet points or features to include.