♻️ refactor: migrate hosting domain and CI #482
Conversation
WalkthroughThe recent updates focus on renaming secrets and updating configurations across various GitHub Actions workflows. The modifications include changing project URLs, GitHub tokens, GPG keys, and Git configurations to reflect new organizational details. Additionally, a new workflow for bumping the Changes
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
There was a problem hiding this comment.
| Device | URL |
|---|---|
| desktop | http://localhost:3000/ |
| Device | URL |
|---|---|
| mobile | http://localhost:3000/ |
Not what you expected? Are your scores flaky? GitHub runners could be the cause.
Try running on Foo instead
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 14
Out of diff range and nitpick comments (2)
docs/nodes/join-testnet.mdx (1)
Line range hint
11-11: Fix grammatical errors.- The [networks repository](https://github.com/okp4/networks) will also contains details regarding upgrades and syncing informations. + The [networks repository](https://github.com/okp4/networks) also contains details regarding upgrades and syncing information.docs/tutorials/cli-1.mdx (1)
Line range hint
407-407: Correct the unpaired symbol in the recap section.- ## Recap' + ## Recap
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (17)
- .github/workflows/add-to-project.yml (1 hunks)
- .github/workflows/auto-fix-md.yml (2 hunks)
- .github/workflows/auto-merge.yml (1 hunks)
- .github/workflows/bump-axoned-version.yml (1 hunks)
- .github/workflows/capture-website.yml (2 hunks)
- .github/workflows/follow-contributor.yml (1 hunks)
- .github/workflows/lint.yml (3 hunks)
- .github/workflows/notify-release.yml (1 hunks)
- .github/workflows/publish.yml (1 hunks)
- .github/workflows/update-versioned-docs.yml (3 hunks)
- README.md (3 hunks)
- data/chain.json (1 hunks)
- docs/nodes/installation.mdx (3 hunks)
- docs/nodes/join-testnet.mdx (1 hunks)
- docs/tutorials/cli-1.mdx (2 hunks)
- docusaurus.config.js (4 hunks)
- package.json (1 hunks)
Files skipped from review due to trivial changes (7)
- .github/workflows/add-to-project.yml
- .github/workflows/auto-fix-md.yml
- .github/workflows/auto-merge.yml
- .github/workflows/lint.yml
- data/chain.json
- docusaurus.config.js
- package.json
Additional Context Used
LanguageTool (12)
README.md (3)
Near line 66: It seems that an auxiliary verb is missing at the beginning of this question.
Context: ...vecommons.org/l/by-sa/4.0/88x31.png ## You want to get involved? 😍 So you want t...
Near line 68: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...## You want to get involved? 😍 So you want to contribute? Great! ❤️ We appreciate any...
Near line 68: Using many exclamation marks might seem excessive (in this case: 7 exclamation marks for a text that’s 2933 characters long)
Context: ...ed? 😍 So you want to contribute? Great! ❤️ We appreciate any help you're willin...docs/nodes/installation.mdx (1)
Near line 59: Consider a shorter alternative to avoid wordiness.
Context: .../Make) is properly installed. -git— in order to clone the project you need to have [`gi...docs/nodes/join-testnet.mdx (2)
Near line 11: The modal verb ‘will’ requires the verb’s base form.
Context: ...s://github.com/okp4/networks) will also contains details regarding upgrades and syncing ...
Near line 11: The word ‘informations’ is a legal term. In standard English, the word ‘information’ is a non-count noun.
<th ...
Context: ... details regarding upgrades and syncing informations.docs/tutorials/cli-1.mdx (6)
Near line 12: Consider an alternative adjective to strengthen your wording.
Context: ...e CLI, you can query the chain, uncover deep insights, and execute transactions with...
Near line 78: Consider a shorter alternative to avoid wordiness.
Context: ... key pair is created to obtain a wallet in order to establish secure ownership and control ...
Near line 260: A comma may be missing after the conjunctive/linking adverb ‘Thus’.
Context: ... "value": "500000uAXON" } ] ' ``` Thus we can get all transfer transactions wh...
Near line 387: Consider adding a comma after this introductory phrase.
Context: ...w-stone` are instantiated, and for each instance what are its contract address, the Axon...
Near line 407: Unpaired symbol: ‘'’ seems to be missing
Context: ...wasm").attributes[] ] }]}' ``` ## Recap' - The CLI allows you to communicate wi...
Near line 415: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional.
Context: ...ion. Stay in touch with our updates and feel free to join our active developer community. We...Additional comments not posted (5)
.github/workflows/follow-contributor.yml (1)
15-15: Token secret updated correctly..github/workflows/publish.yml (1)
37-39: Token secret and custom domain updated correctly..github/workflows/notify-release.yml (1)
14-14: Webhook URL secret updated correctly..github/workflows/capture-website.yml (1)
20-20: Token secret updated correctly.docs/nodes/join-testnet.mdx (1)
31-31: Version reference updated correctly.
There was a problem hiding this comment.
Actionable comments posted: 1
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/tutorials/cli-1.mdx (2 hunks)
Additional Context Used
LanguageTool (6)
docs/tutorials/cli-1.mdx (6)
Near line 12: Consider an alternative adjective to strengthen your wording.
Context: ...e CLI, you can query the chain, uncover deep insights, and execute transactions with...
Near line 78: Consider a shorter alternative to avoid wordiness.
Context: ... key pair is created to obtain a wallet in order to establish secure ownership and control ...
Near line 260: A comma may be missing after the conjunctive/linking adverb ‘Thus’.
Context: ... "value": "500000uAXON" } ] ' ``` Thus we can get all transfer transactions wh...
Near line 387: Consider adding a comma after this introductory phrase.
Context: ...w-stone` are instantiated, and for each instance what are its contract address, the Axon...
Near line 407: Unpaired symbol: ‘'’ seems to be missing
Context: ...wasm").attributes[] ] }]}' ``` ## Recap' - The CLI allows you to communicate wi...
Near line 415: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional.
Context: ...ion. Stay in touch with our updates and feel free to join our active developer community. We...
Learnings (1)
docs/tutorials/cli-1.mdx (2)
User: bdeneux PR: okp4/docs#482 File: docs/nodes/installation.mdx:44-44 Timestamp: 2024-05-15T09:07:51.099Z Learning: When migrating from `okp4d` to `axoned`, update all references of `okp4/okp4d` Docker image to `axone-protocol/axoned` and all `okp4d` command references to `axoned`.User: bdeneux PR: okp4/docs#482 File: docs/nodes/installation.mdx:44-44 Timestamp: 2024-05-15T09:07:51.099Z Learning: When migrating from `okp4d` to `axoned`, update all references of `okp4/okp4d` Docker image to `axone-protocol/axoned` and all `okp4d` command references to `axoned`.
Additional comments not posted (1)
docs/tutorials/cli-1.mdx (1)
30-30: The URL has been correctly updated to reflect the new GitHub organization nameaxone-protocol.
|
@bdeneux I've just created the axone-protocol organisation on npm.js. You've been invited to join. Same for @amimart. |
There was a problem hiding this comment.
Actionable comments posted: 1
Out of diff range and nitpick comments (2)
.github/workflows/update-versioned-docs.yml (2)
Line range hint
55-61: Avoid using variable interpolation inrunsteps for security reasons. Use an intermediate environment variable instead.- rm -rf ${{ github.event.inputs.section }}/* - rsync -rmv --include='*/' --include='*.md' --include='*.mdx' --include='*.json' --exclude='*' tmp/${{ github.event.inputs.docs_directory }} ${{ github.event.inputs.section }} + section="${{ github.event.inputs.section }}" + docs_directory="${{ github.event.inputs.docs_directory }}" + rm -rf "$section"/* + rsync -rmv --include='*/' --include='*.md' --include='*.mdx' --include='*.json' --exclude='*' "tmp/$docs_directory" "$section"
Line range hint
70-73: Avoid using variable interpolation inrunsteps for security reasons. Use an intermediate environment variable instead.- yarn run docusaurus docs:version:${{ github.event.inputs.section }} ${{ github.event.inputs.version }} + section="${{ github.event.inputs.section }}" + version="${{ github.event.inputs.version }}" + yarn run docusaurus docs:version:"$section" "$version"
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (5)
- .github/workflows/add-to-project.yml (1 hunks)
- .github/workflows/auto-fix-md.yml (2 hunks)
- .github/workflows/bump-axoned-version.yml (1 hunks)
- .github/workflows/capture-website.yml (2 hunks)
- .github/workflows/update-versioned-docs.yml (3 hunks)
Files skipped from review as they are similar to previous changes (3)
- .github/workflows/add-to-project.yml
- .github/workflows/auto-fix-md.yml
- .github/workflows/capture-website.yml
Additional Context Used
Learnings (1)
.github/workflows/update-versioned-docs.yml (4)
User: bdeneux PR: okp4/docs#482 File: .github/workflows/update-versioned-docs.yml:48-49 Timestamp: 2024-05-15T08:46:06.245Z Learning: The secret names should remain generic (e.g., `BOT_*`) to avoid issues in case of future rebranding.User: bdeneux PR: okp4/docs#482 File: .github/workflows/update-versioned-docs.yml:12-12 Timestamp: 2024-05-15T09:20:15.111Z Learning: The organization name is `axone-protocol`, not `axone`.User: bdeneux PR: okp4/docs#482 File: docs/tutorials/cli-1.mdx:30-30 Timestamp: 2024-05-15T08:55:56.807Z Learning: The new GitHub organization name is `axone-protocol`, not `axone`.User: bdeneux PR: okp4/docs#482 File: README.md:16-16 Timestamp: 2024-05-15T08:58:05.326Z Learning: The GitHub organization is `axone-protocol`, but the documentation URL is `https://docs.axone.xyz`.
Additional comments not posted (9)
.github/workflows/bump-axoned-version.yml (3)
13-16: The "Check out repository" step looks good.
18-25: The "Import GPG key" step looks good.
36-42: The "Commit axoned version change" step looks good..github/workflows/update-versioned-docs.yml (6)
34-34: The "Check out repository" step looks good.
42-42: The "Check out repository" step with version and repository inputs looks good.
48-49: The "Import GPG key" step looks good.
Line range hint
64-66: The "Setup node environment" step looks good.
86-88: The "Commit documentation draft" step looks good.
95-98: The "Create Pull Request" step looks good.
There was a problem hiding this comment.
Actionable comments posted: 0
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- .github/workflows/capture-website.yml (2 hunks)
Files skipped from review as they are similar to previous changes (1)
- .github/workflows/capture-website.yml
In continuation of the rebranding, this PR bring modification on the CI workflows to use the new organization secrets and rename all reference to the okp4 repository to axone-protocol repository.
okp4byaxoneaxoned#616 (comment))docusaurus.config.jspackage.json❓ Vigilance point
package.jsonfile has been modified with reference to the new axone-protocol repository, I've also change the package name to@axone/docsbut do we need to name it like GitHub :@axone-protocol/docs? Is there a organization to create on NPM or not ?Summary by CodeRabbit
Chores
New Features
axoned.