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

♻️ refactoring: rename okp4 by axone #616

Merged
merged 22 commits into from
May 15, 2024
Merged

♻️ refactoring: rename okp4 by axone #616

merged 22 commits into from
May 15, 2024

Conversation

bdeneux
Copy link
Contributor

@bdeneux bdeneux commented May 3, 2024

📝 Description

This PR prepare the renaming of the chain from okp4 to axone.

📋 Steps :

  • Rename go module
  • Rename binary name
  • Rename proto import
  • Change docker name
  • Regenerate documentation
  • Update all reference to okp4 address to an Axone address in tests and comments
  • Update license, README and CHANGELOG to the new repository
  • Update denom name
  • Update all GitHub action workflow secrets naming (e.i: $OKP4_TOKEN)

📣 External or admin steps

  • $BUF_TOKEN used in publish.yml should be linked to the buf okp4 organization and we need to rename it or recreate a new one for axone. but.yml configuration follow the same name than GitHub : buf.build/axone-protocol/axoned
  • The same for the docker registry that is named like the GitHub repository : axone-protocol/axoned ($DOCKER_HUB_REGISTRY_TOKEN, $DOCKER_HUB_REGISTRY_ID)
  • $OKP4_TOKEN should be renamed to $OPS_TOKEN and all related organization secrets should be transferred to the new organization. Repository secrets are kept during the transfer : (https://docs.github.com/en/repositories/creating-and-managing-repositories/transferring-a-repository#whats-transferred-with-a-repository)
  • OKP4 Bot secrets renaming :
    • $OKP4_BOT_GPG_PRIVATE_KEY --> $BOT_GPG_PRIVATE_KEY
    • $OKP4_BOT_GPG_PASSPHRASE --> $BOT_GPG_PASSPHRASE
    • $OKP4_BOT_GIT_AUTHOR_NAME --> $BOT_GIT_AUTHOR_NAME
    • $OKP4_BOT_GIT_AUTHOR_EMAIL --> $BOT_GIT_AUTHOR_EMAIL
    • $OKP4_BOT_GIT_COMMITTER_NAME --> $BOT_GIT_COMMITTER_NAME
    • $OKP4_BOT_GIT_COMMITTER_EMAIL --> $BOT_GIT_COMMITTER_EMAIL
  • Discord bot secrets also : $OKP4_DISCORD_WEBHOOK --> $DISCORD_WEBHOOK
  • The README contains link to the okp4 testnet that should be updated when new axone testnet will be deployed.
  • CI workflow that trigger another workflows is linked to the OKP4 organization too, since documentation will be transferred also (I think?), I update the link to the new axone-protocol organization.
  • Variable name in docs should be renamed to axonedVersion : https://github.com/okp4/docs/blob/5d2c59a1767ac0e3ff1850ef7b77b653dc7f88e3/data/chain.json#L2

Copy link
Contributor

coderabbitai bot commented May 3, 2024

Important

Auto Review Skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

244 files out of 300 files are above the max files limit of 50. Please upgrade to Pro plan to get higher limits.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

@bdeneux
Copy link
Contributor Author

bdeneux commented May 3, 2024

@amimart Is up to you now for the admin steps 😉

@bdeneux bdeneux marked this pull request as ready for review May 3, 2024 17:22
@bdeneux bdeneux requested review from ccamel and amimart May 3, 2024 17:29
@ccamel ccamel force-pushed the refactor/renaming branch from 9686ad7 to 67de30f Compare May 4, 2024 14:42
@ccamel ccamel force-pushed the refactor/renaming branch from 67de30f to b95d66c Compare May 4, 2024 14:55
@ccamel
Copy link
Member

ccamel commented May 4, 2024

Hey @bdeneux, just wanted to let you know that I added a ! to your latest commit as per the conventional commit spec, to indicate the breaking change introduced by your PR. Also, I've made some updates to align the protocol description with Axone's narrative.

@amimart
Copy link
Member

amimart commented May 14, 2024

I completed the CI & admin steps, here's a sum up:

Secrets change:

  • OKP4_TOKEN -> OPS_TOKEN
  • OKP4_BOT_* -> BOT_*
  • OKP4_DISCORD_WEBHOOK -> DISCORD_WEBHOOK

All the secrets have been created on the axone organisation except the ones concerning the docker hub publication, the new docker organisation being in the process of creation I just disabled the related image push temporarily.

About the testnet referenced in the readme it is obsolete now, I propose to manage that matter post-migration.

We'll take care of the changes related to docs when we migrate it.

I also took the opportunity to disable the auto comments on PRs and issues after a release.

Copy link
Member

@ccamel ccamel left a comment

Choose a reason for hiding this comment

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

All good! 👍

@amimart amimart merged commit 5aa621d into main May 15, 2024
19 checks passed
@amimart amimart deleted the refactor/renaming branch May 15, 2024 14:32
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.

3 participants