chore: constant rollkit ignite app version #399
Conversation
WalkthroughThis update introduces dynamic constants to various tutorial and guide files, replacing hardcoded version numbers with imported constants from a central Changes
Poem
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 (
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Outside diff range and nitpick comments (6)
tutorials/celestia-da.md (3)
Line range hint
60-60: Remove unnecessary multiple blank lines to maintain consistency.- -Also applies to: 63-63
Line range hint
72-72: Specify the language for the code block to enhance markdown formatting.-```bash +```bash
Line range hint
113-114: Sensitive information leak detected: JSON Web Token (JWT) exposed in the documentation.Please ensure that the JWT is not sensitive or replace it with a placeholder to prevent potential security risks.
tutorials/wordle.md (3)
Line range hint
572-572: Remove unnecessary multiple blank lines to maintain consistency.-
Line range hint
155-155: Correct table formatting to include trailing pipes for consistency and proper rendering.-| readme.md | A readme file for your sovereign application-specific blockchain project. +| readme.md | A readme file for your sovereign application-specific blockchain project. |
Line range hint
761-761: Consider breaking long lines to adhere to markdown best practices.It's a good practice to keep line lengths under 80 characters for better readability in markdown files.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (4)
- .vitepress/constants/constants.js (1 hunks)
- tutorials/celestia-da.md (2 hunks)
- tutorials/cosmwasm.md (3 hunks)
- tutorials/wordle.md (1 hunks)
Files skipped from review due to trivial changes (1)
- .vitepress/constants/constants.js
Additional context used
Markdownlint
tutorials/celestia-da.md
60-60: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
63-63: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
72-72: null (MD040, fenced-code-language)
Fenced code blocks should have a language specifiedtutorials/cosmwasm.md
139-139: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
251-251: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
145-145: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
178-178: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
251-251: Expected: 80; Actual: 90 (MD013, line-length)
Line lengthtutorials/wordle.md
572-572: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
761-761: Expected: 80; Actual: 138 (MD013, line-length)
Line length
155-155: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe (MD055, table-pipe-style)
Table pipe style
Gitleaks
tutorials/celestia-da.md
113-114: Uncovered a JSON Web Token, which may lead to unauthorized access to web applications and sensitive user data. (jwt)
LanguageTool
tutorials/cosmwasm.md
[style] ~139-~139: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ... You will need a local-da node running in order to complete this tutorial. To start it, ru...
[grammar] ~148-~148: The word “setup” is a noun. The verb is spelled with a space. (NOUN_VERB_CONFUSION)
Context: ...thewasmdbinary is built, we need to setup a local network that communicates betwe...
[style] ~219-~219: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...requires Docker in order to compile. <!-- markdownlint-enable MD051...
[style] ~248-~248: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ... Let's now deploy our smart contract! In order to deploy a contract, you can use the comm...tutorials/wordle.md
[style] ~35-~35: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ld) You do not have to do those guides in order to follow this Wordle tutorial, but doing ...
[style] ~77-~77: Consider using a more formal and expressive alternative to ‘amazing’. (AWESOME)
Context: ...--> ### 🔥 Ignite {#ignite} Ignite is an amazing CLI tool to help us get started buildin...
[uncategorized] ~91-~91: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...ocal machine. This tutorial uses a macOS but it should work for Windows. For Windows...
[uncategorized] ~104-~104: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...p ``` You should see an output of help commands meaning Ignite was installed successful...
[style] ~278-~278: Consider using “who” when you are referring to a person instead of an object. (THAT_WHO)
Context: ...submitter` is the address of the person that submitted the Wordle. The second type ...
[uncategorized] ~393-~393: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ... We then create a hash from the current day the moment the Wordle was submitted. ...
[uncategorized] ~393-~393: Possible missing preposition found. (AI_HYDRA_LEO_MISSING_TO)
Context: ...then create a hash from the current day the moment the Wordle was submitted. We s...
[uncategorized] ~513-~513: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...the hash string of the current day. * Next we create a hash string of current day ...
[uncategorized] ~513-~513: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ... day. * Next we create a hash string of current day and the Submitter. This allows us...
[uncategorized] ~518-~518: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ... continue guessing a new wordle every day up to the max of 6 tries per day. * We ...
[style] ~543-~543: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...oins method to the BankKeeper interface in order to allow sending the reward to the right g...
[uncategorized] ~647-~647: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ... then get a response with a transaction hash as shown here: ```bash code: 0 codespa...
[grammar] ~718-~718: When ‘five-letter’ is used as a modifier, it is usually spelled with a hyphen. (WORD_ESSAY_HYPHEN)
Context: ... for the day. Now let’s try to guess a five letter word: <!-- markdownlint-disable MD013 ...
[style] ~748-~748: ‘prior to’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_PRIOR_TO)
Context: ... correct word. 2. You can hash the word prior to submitting it to the chain, ensuring ...
[uncategorized] ~754-~754: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...mblebun/wordle-cli). 4. You can improve current date to stick to a specific timezone. 5...
[style] ~756-~756: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...wordle every day at a specific time. 6. You can create a vue.js front-end with Igni...
Additional comments not posted (5)
tutorials/celestia-da.md (2)
41-42: Validate the dynamic version reference in the installation command.Ensure that the
{{constants.rollkitIgniteAppVersion}}is correctly replaced during the build process and reflects the intended version.
4-6: Ensure the import path for constants is correct and accessible.Verification successful
The file
constants.jsdoes exist in the.vitepress/constantsdirectory, confirming the import path is correct and accessible.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the import path for constants.js is correct and accessible. # Test: Check if the file exists at the specified path. if [[ -f "../.vitepress/constants/constants.js" ]]; then echo "The file exists." else echo "The file does not exist." fiLength of output: 106
Script:
#!/bin/bash # Description: Verify the existence of the .vitepress directory and constants.js file. # Check if the .vitepress directory exists. if fd --type d --hidden --exclude .git | grep -q '.vitepress'; then echo ".vitepress directory exists." else echo ".vitepress directory does not exist." fi # Check for any constants.js file in the repository. fd --type f --name 'constants.js' --hidden --exclude .gitLength of output: 434
Script:
#!/bin/bash # Description: Verify the existence of the .vitepress directory and constants.js file. # Check if the .vitepress directory exists. if fd --type d --hidden --exclude .git | grep -q '.vitepress'; then echo ".vitepress directory exists." else echo ".vitepress directory does not exist." fi # Correct the fd command syntax and search for constants.js file in the repository. fd --type f 'constants.js' --hidden --exclude .gitLength of output: 210
tutorials/cosmwasm.md (2)
34-34: Validate the dynamic version reference in the installation script.Ensure that the
{{constants.golangVersion}}is correctly replaced during the build process and reflects the intended version.
141-142: Validate the dynamic version reference in the installation script for the local DA node.Ensure that the
{{constants.localDALatestTag}}is correctly replaced during the build process and reflects the intended version.tutorials/wordle.md (1)
171-172: Validate the dynamic version reference in the installation command.Ensure that the
{{constants.rollkitIgniteAppVersion}}is correctly replaced during the build process and reflects the intended version.
yarikbratashchuk
force-pushed
the
yarik/rollkit-app-constant
branch
from
a85d529 to
39fd929
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- .vitepress/constants/constants.js (1 hunks)
- guides/connect-local-da.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- .vitepress/constants/constants.js
Additional comments not posted (1)
guides/connect-local-da.md (1)
4-6: The import of constants is correctly set up to facilitate dynamic content in the document.
Summary by CodeRabbit
New Features
Documentation