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 publish-package.yml #193

Merged
merged 4 commits into from
Jun 6, 2024
Merged

Update publish-package.yml #193

merged 4 commits into from
Jun 6, 2024

Conversation

cenevan
Copy link
Contributor

@cenevan cenevan commented May 14, 2024

Description

GHA Job to send notification to Slack Once Package Published to NPM Registry

Related Issue

#187

Summary by CodeRabbit

  • New Features
    • Added Slack notifications for package publishing events to keep users informed in real-time.

Copy link

coderabbitai bot commented Jun 5, 2024

Walkthrough

A new step named send_slack_notif has been added to the GitHub Actions workflow file .github/workflows/publish-package.yaml. This step is designed to send a notification to Slack whenever a package is published to the NPM Registry, enhancing communication and awareness among team members about deployment events.

Changes

File Change Summary
.github/workflows/publish-package.yaml Added a new step send_slack_notif to send Slack notifications with specific configuration details.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant Developer
    participant GitHub Actions
    participant NPM Registry
    participant Slack

    Developer->>GitHub Actions: Push changes
    GitHub Actions->>NPM Registry: Publish package
    GitHub Actions->>Slack: Send Slack notification
    Slack->>Team Members: Notify about package published
Loading

Poem

In the world of code, a change so bright,
A Slack message sent, in the dead of night.
Packages published, a team aware,
With a simple notif, showing we care.
🎉✨ Let's celebrate, with a rabbit's cheer,
For seamless updates, we hold 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 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between efc2702 and 410f7e9.

Files selected for processing (1)
  • .github/workflows/publish-package.yaml (1 hunks)
Additional comments not posted (1)
.github/workflows/publish-package.yaml (1)

130-140: Ensure the new Slack notification step is correctly integrated.

The new send_slack_notif job is well-integrated with the existing workflow, correctly depending on both build-test-publish and create_release jobs. The usage of secrets and parameters in the with block appears correct. However, verify the image URL and ensure the Slack bot token has the necessary permissions.

Verification successful

The new send_slack_notif job is well-integrated with the existing workflow, correctly depending on both build-test-publish and create_release jobs. The usage of secrets and parameters in the with block appears correct. The image URL is valid and accessible, and the secrets are correctly referenced in the workflow file.

Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the image URL is accessible and valid.

# Test: Check if the image URL returns a successful HTTP status code.
curl -o /dev/null --silent --head --write-out '%{http_code}' https://imgur.com/a/6P1xFvE

Length of output: 94



Script:

#!/bin/bash
# Description: Verify the usage of secrets in the workflow file.

# Test: Check if the secrets are correctly referenced in the workflow file.
grep -E 'secrets\.(SLACK_CHANNEL_ID_STORY_57BLOCKS|SLACK_BOT_TOKEN)' .github/workflows/publish-package.yaml

Length of output: 230

Copy link
Contributor

@AndyBoWu AndyBoWu left a comment

Choose a reason for hiding this comment

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

LGTM

@AndyBoWu AndyBoWu merged commit ddfa155 into storyprotocol:main Jun 6, 2024
8 of 9 checks passed
bonnie57 pushed a commit that referenced this pull request Jul 2, 2024
* Update publish-package.yaml

* Update publish-package.yaml

* Update publish-package.yaml

* reusable slack workflow implemented
edisonz0718 added a commit that referenced this pull request Jul 9, 2024
* [feat] refactor the package publication workflow (#152)

* [test] create release (#153)

* [feature] remove legacy workflow to create gh release (#157)

* Test/create release workflow (#155)

* [test] create release

* [test] create release - 2

* Update publish-package.yaml (#158)

* [fix] add condition check back

* Fix CI syntax issue

* Cenevan demo (#195)

* Create test-slack-notifs.yml

* Update test-slack-notifs.yml

* Update test-slack-notifs.yml (#196)

* Changed description and title for demo (#197)

* Update test-slack-notifs.yml

* Update test-slack-notifs.yml

* Update publish-package.yml (#193)

* Update publish-package.yaml

* Update publish-package.yaml

* Update publish-package.yaml

* reusable slack workflow implemented

* Update publish-package.yaml (#211)

* Update publish-package.yaml (#217)

* Bump up react sdk to 0.0.1

* Make react-sdk test's timeout longer

* Update publish-package.yaml

* Update @story-protocol/[email protected] in react sdk

* Fix nonce issue when run integration test

* Update style when run npm run generate command

* Skip test about Non-Commercial Remix

* Upgrade pnpm/action-setup version

---------

Co-authored-by: Andy Wu <[email protected]>
Co-authored-by: Ze <[email protected]>
Co-authored-by: cenevan <[email protected]>
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