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

fix: rename references to development to main #712

Merged
merged 1 commit into from
Dec 9, 2024

Conversation

crnbarr93
Copy link
Contributor

@crnbarr93 crnbarr93 commented Dec 9, 2024

Motivation

The development branch has been renamed to main. These changes are to support this change.

Summary by CodeRabbit

  • New Features

    • Updated workflows to trigger only on the main branch for pull requests.
    • Improved clarity and formatting in the README.md, including updated image sources and links.
  • Bug Fixes

    • Corrected image and link references in the README.md to point to the main branch.
  • Documentation

    • Enhanced README.md with formatting adjustments and clearer section organization.

@crnbarr93 crnbarr93 requested a review from joemonem December 9, 2024 15:14
Copy link
Contributor

coderabbitai bot commented Dec 9, 2024

Walkthrough

The changes in this pull request primarily involve updates to configuration files in the GitHub repository. The .github/mergify.yml file has been modified to change the base branch for backporting rules from development to main. Additionally, several workflow files, including .github/workflows/build.yml, .github/workflows/changelog.yml, and .github/workflows/rust.yml, have had their triggering branches updated to only include main. The README.md file has also been updated to reflect these branch changes, particularly in image sources and links.

Changes

File Path Change Summary
.github/mergify.yml Changed base branch for backport rules from development to main for both backport rules.
.github/workflows/build.yml Updated triggering branches from main, development to main only for pull request events.
.github/workflows/changelog.yml Removed development branch from the trigger list, leaving only main.
.github/workflows/rust.yml Updated triggering branches from main, development to main only for pull request events.
README.md Updated image sources and links to point to main instead of development; minor formatting changes.

Possibly related PRs

Suggested labels

ci: skip-changelog, backport/v1.1.x, backport/release/3

Suggested reviewers

  • SlayerAnsh
  • joemonem
  • cowboy0015

Poem

In the land of code where rabbits play,
We changed the paths, made a brighter day.
From development to main we hop,
Ensuring our workflows never stop!
With links and images all aligned,
A clearer README, oh so refined! 🐰✨


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.

@crnbarr93 crnbarr93 added the ci: skip-changelog Skips the changelog check in CI label Dec 9, 2024
Copy link
Contributor

@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 (3)
README.md (3)

3-3: Add alt text for better accessibility

Please add descriptive alt text to the image for better accessibility.

-<img src="https://github.com/andromedaprotocol/andromeda-core/blob/main/asset/core-logo.png" width=1000>
+<img src="https://github.com/andromedaprotocol/andromeda-core/blob/main/asset/core-logo.png" width=1000 alt="AndromedaOS Core Logo">
🧰 Tools
🪛 Markdownlint (0.35.0)

3-3: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


27-27: Consider these language improvements for better clarity

A few minor language improvements could enhance readability:

  1. Add a period after "etc" (line 27)
  2. Replace "in order to" with "to" for conciseness (line 59)
  3. Add a comma after "which" (line 65)
-network, etc
+network, etc.

-teams in order to build
+teams to build

-25 ADOs which is
+25 ADOs, which is

Also applies to: 59-59, 65-65

🧰 Tools
🪛 LanguageTool

[style] ~27-~27: In American English, abbreviations like “etc.” require a period.
Context: ...or referencing ADOs, services, network, etc

(ETC_PERIOD)


112-112: Fix grammatical issues

There are a few grammatical issues to address:

  1. Remove duplicate article "an a" (line 112)
  2. Add hyphens to "all-in-one" (line 206)
-run an a sale
+run a sale

-an all in one tool
+an all-in-one tool

Also applies to: 206-206

🧰 Tools
🪛 LanguageTool

[grammar] ~112-~112: Two determiners in a row. Choose either “an” or “a”.
Context: ...ontract that can receive an NFT and run an a sale on it. ...

(DT_DT)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3afd7f5 and 4eb2a60.

📒 Files selected for processing (5)
  • .github/mergify.yml (1 hunks)
  • .github/workflows/build.yml (2 hunks)
  • .github/workflows/changelog.yml (0 hunks)
  • .github/workflows/rust.yml (1 hunks)
  • README.md (7 hunks)
💤 Files with no reviewable changes (1)
  • .github/workflows/changelog.yml
🧰 Additional context used
🪛 Markdownlint (0.35.0)
README.md

3-3: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


67-67: null
Spaces inside link text

(MD039, no-space-in-links)

🪛 LanguageTool
README.md

[style] ~27-~27: In American English, abbreviations like “etc.” require a period.
Context: ...or referencing ADOs, services, network, etc

(ETC_PERIOD)


[style] ~59-~59: Consider a shorter alternative to avoid wordiness.
Context: ...d need to hire a full development teams in order to build their projects and custom smart c...

(IN_ORDER_TO_PREMIUM)


[style] ~59-~59: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...omeda eliminates this need by providing a very large amount of custom smart contracts that u...

(EN_WEAK_ADJECTIVE)


[uncategorized] ~65-~65: Possible missing comma found.
Context: ...s it stands, the ALL contains around 25 ADOs which is the tip of the iceberg. More a...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~85-~85: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...lassified based on their functionality. Currently we have 7 different contract categories...

(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)


[grammar] ~90-~90: Consider using either the past participle “allowed” or the present participle “allowing” here.
Context: ... | Contracts that are allow interaction with different ecosystem pr...

(BEEN_PART_AGREEMENT)


[style] ~104-~104: The preposition ‘amongst’ is correct, but some people think that it is old-fashioned or literary. A more frequently used alternative is the preposition “among”.
Context: ...| Contract used to split any sent funds amongst defined addresses. ...

(AMONGST)


[grammar] ~112-~112: Two determiners in a row. Choose either “an” or “a”.
Context: ...ontract that can receive an NFT and run an a sale on it. ...

(DT_DT)


[typographical] ~206-~206: Consider adding a comma after ‘Usually’ for more clarity.
Context: ... deployed on many of the Cosmos chains. Usually this will require you to set up an envi...

(RB_LY_COMMA)


[grammar] ~206-~206: It seems that hyphens are missing.
Context: ...dromeda has built the Andromeda CLI, an all in one tool to build, interact, and manage ADO...

(ALL_IN_ONE_HYPHEN)

🔇 Additional comments (4)
.github/mergify.yml (1)

10-10: LGTM! Branch references correctly updated.

The base branch references have been properly updated from 'development' to 'main' in both backporting rules.

Let's verify no other branch references were missed:

Also applies to: 18-18

✅ Verification successful

Branch references are correctly updated, no other occurrences found

After examining all YAML files in the repository, the only branch references are in the mergify.yml file, and they have been properly updated from 'development' to 'main'. No other instances of 'development' branch references were found that would need updating.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any remaining 'development' references in yaml files
rg -l "development" --type yaml

Length of output: 31


Script:

#!/bin/bash
# Let's try a more comprehensive search for branch references in yaml files
rg -i "base.*=.*(?:development|main)" --type yaml

# Also search for any branch-related configurations
rg -i "branch.*:.*(?:development|main)" --type yaml

Length of output: 105


Script:

#!/bin/bash
# Let's examine the content of mergify.yml directly
cat .github/mergify.yml

# Also search for any yaml files that might contain branch configurations
fd -e yml -e yaml --exec cat {}

Length of output: 1461

.github/workflows/rust.yml (1)

7-7: LGTM! Workflow trigger updated correctly.

The pull request trigger has been properly updated to target the 'main' branch.

Let's verify the workflow trigger configuration:

✅ Verification successful

Branch trigger configuration is consistent across workflows

After reviewing all workflow files, the branch trigger configuration in rust.yml is correctly aligned with other workflow files:

  • build.yml triggers on pull requests to main branch
  • changelog.yml triggers on pull requests to main branch
  • rust.yml triggers on pull requests to main branch
  • deploy.yml and release.yml use different trigger conditions as they serve different purposes
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for consistent branch triggers across workflow files
echo "Checking workflow triggers across all workflow files..."
rg -A 5 "on:[^}]*pull_request:" .github/workflows/

Length of output: 173


Script:

#!/bin/bash
# Let's try a different approach to check workflow triggers
echo "Checking all workflow files for pull_request triggers..."
find .github/workflows -type f -name "*.yml" -exec sh -c 'echo "\nFile: {}"; cat {}' \;

Length of output: 14711

.github/workflows/build.yml (1)

4-4: LGTM! Build workflow trigger updated correctly.

The pull request trigger has been properly updated to target the 'main' branch.

Let's verify the deployment configuration:

✅ Verification successful

Let me gather more context about the check-kernel step to understand the branch reference.


Let me check the actual implementation of the check-kernel step to understand how the branch is determined.


Branch references in deployment workflow are correctly configured

The verification shows that all branch references are properly configured:

  • The check-kernel step dynamically sets branch to either 'develop' or 'testnet-staging' based on kernel address
  • The schema parser checkout uses this dynamic branch reference
  • The deployment trigger in build.yml uses the current PR's ref
  • No hardcoded 'development' branch references found
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for any remaining branch references in deployment configurations
echo "Checking deployment workflow references..."
rg -A 5 "ref:|branch:|development" .github/workflows/deploy.yml || true

# Check for branch references in deployment scripts
echo "Checking deployment scripts..."
fd -t f . scripts/ -x rg -l "development" {} || true

Length of output: 644


Script:

#!/bin/bash
# Check the check-kernel step definition and its outputs
echo "Checking check-kernel step..."
rg -B 5 -A 5 "check-kernel" .github/workflows/deploy.yml

# Check if there are any other workflow files that might reference development branch
echo "Checking other workflow files for branch references..."
fd -e yml -e yaml . .github/workflows/ -x rg -l "development|ref:|branch:" {} || true

Length of output: 1203


Script:

#!/bin/bash
# Get the full content of deploy.yml to analyze the check-kernel step implementation
echo "Checking check-kernel step implementation..."
rg -A 20 "id: check-kernel" .github/workflows/deploy.yml

# Check build.yml for any related configurations
echo "Checking build.yml contents..."
cat .github/workflows/build.yml

Length of output: 3949

README.md (1)

89-94: Verify all branch references are updated

The branch references have been updated correctly in the tables. Let's verify no references were missed.

Also applies to: 102-118

✅ Verification successful

Branch references have been successfully updated

The search results show that all instances of "development" in the markdown files are related to general development concepts and documentation, not to branch references. No remaining GitHub URLs or branch references containing "development" were found, confirming that the updates in the tables were comprehensive.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any remaining references to the 'development' branch

# Search for 'development' branch references
echo "Checking for remaining 'development' branch references..."
rg -i "development.*branch|branch.*development" --type md

# Search for URLs containing 'development'
echo "Checking for URLs containing 'development'..."
rg -i "github\.com.*\/development\/" --type md

Length of output: 454


Script:

#!/bin/bash
# Description: Check for any remaining references to the 'development' branch with fixed regex

# Search for 'development' branch references
echo "Checking for remaining 'development' branch references..."
rg -i "development.*branch|branch.*development" README.md

# Search for URLs containing 'development'
echo "Checking for URLs containing 'development'..."
rg -i "github.com.*development" README.md

# Check all markdown files for any remaining 'development' references
echo "Checking all markdown files for 'development' references..."
fd -e md -x rg -i "development" {}

Length of output: 2706

🧰 Tools
🪛 LanguageTool

[grammar] ~90-~90: Consider using either the past participle “allowed” or the present participle “allowing” here.
Context: ... | Contracts that are allow interaction with different ecosystem pr...

(BEEN_PART_AGREEMENT)

Copy link
Contributor

@joemonem joemonem left a comment

Choose a reason for hiding this comment

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

Do we need to do any adjustments for dependabot?

@crnbarr93
Copy link
Contributor Author

Do we need to do any adjustments for dependabot?

It works off primary branch AFAIK.

@crnbarr93 crnbarr93 merged commit 0b6042f into main Dec 9, 2024
12 of 13 checks passed
@crnbarr93 crnbarr93 deleted the connor/development-rename branch December 9, 2024 19:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci: skip-changelog Skips the changelog check in CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants