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

ci(workflow): fix set-env job (checkout + token) #658

Merged
merged 1 commit into from
Nov 13, 2024
Merged

Conversation

ccamel
Copy link
Member

@ccamel ccamel commented Nov 13, 2024

Self explanatory.

(same than axone-protocol/axoned#814)

Summary by CodeRabbit

  • Chores
    • Enhanced release notification process for improved security and access.
    • Added authentication token for GitHub API access during release processes.
    • Updated workflow to ensure repository content is accessible during execution.

Copy link

coderabbitai bot commented Nov 13, 2024

Walkthrough

The pull request modifies the .github/workflows/notify-release.yml file to improve the release notification process. It introduces a new step for checking out the repository using actions/checkout@v4 in both the set-env and notify-github-discussion jobs. An environment variable GH_TOKEN is added for authentication with GitHub's API, enhancing security when retrieving release information. The workflow structure remains largely unchanged, but the updates ensure better access to necessary resources during execution.

Changes

File Change Summary
.github/workflows/notify-release.yml - Added actions/checkout@v4 to set-env and notify-github-discussion jobs.
- Introduced GH_TOKEN for GitHub API authentication.
- Updated changelog extraction to utilize GH_TOKEN in notify-github-discussion job.
- No changes to update-docs and update-schema jobs logic, but they now also use GH_TOKEN.

Possibly related PRs

  • Ci/notify discussions release #643: The changes in this PR also modify the .github/workflows/notify-release.yml file, specifically enhancing the notification process and restructuring jobs, which directly relates to the changes made in the main PR regarding the workflow's authentication and repository checkout steps.

Suggested reviewers

  • amimart
  • bdeneux

🐰 In the meadow, where the bunnies play,
A workflow's magic brightens the day.
With tokens secure and steps aligned,
Our releases now dance, perfectly timed.
So hop along, let the updates flow,
In the world of code, we’re ready to go! 🌼


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@ccamel ccamel self-assigned this Nov 13, 2024
Copy link

codecov bot commented Nov 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

see 7 files with indirect coverage changes

@bot-anik
Copy link
Member

size-limit report 📦

Path Size
target/wasm32-unknown-unknown/release/axone_objectarium.wasm 458.07 KB (0%)
target/wasm32-unknown-unknown/release/axone_law_stone.wasm 593.03 KB (0%)
target/wasm32-unknown-unknown/release/axone_cognitarium.wasm 882.05 KB (0%)
target/wasm32-unknown-unknown/release/axone_dataverse.wasm 682.7 KB (0%)

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

🧹 Outside diff range and nitpick comments (1)
.github/workflows/notify-release.yml (1)

Line range hint 44-49: Add error handling for GitHub CLI commands.

The release view command could fail silently if the tag doesn't exist or if there are API issues. Consider adding error handling:

       - name: Extract changelog for tag
         run: |
+          set -e  # Exit on any error
           {
             echo 'CHANGELOG<<EOF'
-            gh release view ${{ needs.set-env.outputs.tag }} --json body -q '.body'
+            if ! gh release view ${{ needs.set-env.outputs.tag }} --json body -q '.body'; then
+              echo "::error::Failed to fetch release information for tag ${{ needs.set-env.outputs.tag }}"
+              exit 1
+            fi
             echo 'EOF'
           } >> "$GITHUB_ENV"
         env:
           GH_TOKEN: ${{ secrets.OPS_TOKEN }}
🧰 Tools
🪛 actionlint

24-24: shellcheck reported issue in this script: SC2086:info:6:20: Double quote to prevent globbing and word splitting

(shellcheck)


24-24: shellcheck reported issue in this script: SC2295:info:8:31: Expansions inside ${..} need to be quoted separately, otherwise they match as patterns

(shellcheck)


24-24: shellcheck reported issue in this script: SC2086:info:9:32: Double quote to prevent globbing and word splitting

(shellcheck)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f74d792 and 2e18e94.

📒 Files selected for processing (1)
  • .github/workflows/notify-release.yml (2 hunks)
🔇 Additional comments (2)
.github/workflows/notify-release.yml (2)

19-21: LGTM! Improved workflow reliability with proper checkout and authentication.

The changes correctly address two important aspects:

  1. Added repository checkout using the latest actions/checkout@v4
  2. Added proper authentication using OPS_TOKEN for GitHub API access

Also applies to: 36-36


36-36: Verify OPS_TOKEN permissions across repositories.

The OPS_TOKEN is used for cross-repository operations. Ensure it has the minimum required permissions:

  • Read access to releases and contents
  • Write access to discussions
  • Workflow dispatch permissions for docs and schema repositories

Also applies to: 36-36

✅ Verification successful

OPS_TOKEN permissions are properly configured.
The OPS_TOKEN has access to the required repositories, and discussions are disabled where applicable.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the repositories and required permissions

# Check if the token has access to the required repositories
for repo in "axone-protocol/docs" "axone-protocol/axone-contract-schema"; do
  echo "Checking access to $repo..."
  gh api "/repos/$repo" --silent || echo "No access to $repo"
done

# Check if discussions are enabled in the target repository
gh api graphql -f query='
  query($owner: String!, $name: String!) {
    repository(owner: $owner, name: $name) {
      hasDiscussionsEnabled
      discussionCategories(first: 10) {
        nodes {
          id
          name
        }
      }
    }
  }' -f owner='axone-protocol' -f name='contracts'

Length of output: 867

@ccamel ccamel merged commit dd19da5 into main Nov 13, 2024
18 checks passed
@ccamel ccamel deleted the ci/fix-notify-release branch November 13, 2024 12:09
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