feat: generate typescript and publish on merge #143
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughThis update introduces a workflow for publishing TypeScript code, enhancing the project's automation capabilities. It adds and modifies recipes in the Changes
Assessment against linked issues
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.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files selected for processing (2)
- .github/workflows/publish-ts.yml (1 hunks)
- justfile (2 hunks)
Additional comments: 3
.github/workflows/publish-ts.yml (1)
- 3-28: The workflow is well-structured and follows best practices for GitHub Actions. However, consider the following points for improvement:
- Security: Ensure that
DEPLOY_KEYis securely stored as a GitHub secret and has the minimal required access rights on the deployment server.- Node.js Version: Using a specific version of Node.js (
"14") is good for consistency. However, verify if this version aligns with the project's current Node.js version requirements to avoid potential compatibility issues.- rsync Usage: The
rsynccommand uses-avzflags for verbose, archive mode, and compression. Ensure that verbose mode (-v) does not leak sensitive information in the logs. Additionally, consider specifying the exact directories or files to sync to avoid unintentional overwrites.justfile (2)
- 4-4: Adding
set dotenv-loadis a good practice for managing environment variables. Ensure that the.envfile is properly secured and not checked into version control to prevent accidental exposure of sensitive information.- 121-137: The
gen-tsrecipe introduces a new process for generating TypeScript code. While the approach is generally sound, consider the following points:
- Schema Directory Handling: The script assumes the presence of a
schemadirectory. Ensure that this directory is created or checked for existence before proceeding with the TypeScript generation to avoid potential errors.- Error Handling: Similar to the
gen-schemarecipe, ensure proper error handling and exit codes for each step of the process to maintain robustness in automated environments.
Comment on lines
+94
to
+118
| initial_dir=$PWD | ||
| for dir in contracts/*; do | ||
| dir_name=$(basename $dir) | ||
| echo "Generating schema for $dir_name..." | ||
|
|
||
| # Change to the contract directory | ||
| if cd $dir; then | ||
| # Check if 'cargo schema' can be run successfully | ||
| if cargo schema; then | ||
| # Move back to the initial directory | ||
| cd $initial_dir | ||
| # Create target schema directory if it doesn't exist | ||
| mkdir -p schema/$dir_name | ||
| # Move the generated schema to the target directory | ||
| if ! mv $dir/schema schema/$dir_name; then | ||
| echo "Failed to move schema directory for $dir_name." | ||
| fi | ||
| else | ||
| cd $initial_dir | ||
| fi | ||
| else | ||
| echo "Failed to change directory to $dir." | ||
| fi | ||
| done |
There was a problem hiding this comment.
The gen-schema recipe has been enhanced to handle directory changes and schema generation more robustly. Consider the following improvements:
- Error Handling: Ensure that the script exits with a non-zero status code when encountering errors to prevent silent failures in CI/CD pipelines.
- Directory Navigation: Use
pushdandpopdinstead ofcdfor changing directories. This approach is more reliable and readable, especially in scripts with multiple directory changes.
- if cd $dir; then
+ if pushd $dir > /dev/null; then
- cd $initial_dir
+ popd > /dev/nullCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
Suggested change
| #!/usr/bin/env bash | |
| initial_dir=$PWD | |
| for dir in contracts/*; do | |
| dir_name=$(basename $dir) | |
| echo "Generating schema for $dir_name..." | |
| # Change to the contract directory | |
| if cd $dir; then | |
| # Check if 'cargo schema' can be run successfully | |
| if cargo schema; then | |
| # Move back to the initial directory | |
| cd $initial_dir | |
| # Create target schema directory if it doesn't exist | |
| mkdir -p schema/$dir_name | |
| # Move the generated schema to the target directory | |
| if ! mv $dir/schema schema/$dir_name; then | |
| echo "Failed to move schema directory for $dir_name." | |
| fi | |
| else | |
| cd $initial_dir | |
| fi | |
| else | |
| echo "Failed to change directory to $dir." | |
| fi | |
| done | |
| #!/usr/bin/env bash | |
| initial_dir=$PWD | |
| for dir in contracts/*; do | |
| dir_name=$(basename $dir) | |
| echo "Generating schema for $dir_name..." | |
| # Change to the contract directory | |
| if pushd $dir > /dev/null; then | |
| # Check if 'cargo schema' can be run successfully | |
| if cargo schema; then | |
| # Move back to the initial directory | |
| popd > /dev/null | |
| # Create target schema directory if it doesn't exist | |
| mkdir -p schema/$dir_name | |
| # Move the generated schema to the target directory | |
| if ! mv $dir/schema schema/$dir_name; then | |
| echo "Failed to move schema directory for $dir_name." | |
| fi | |
| else | |
| popd > /dev/null | |
| fi | |
| else | |
| echo "Failed to change directory to $dir." | |
| fi | |
| done |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix #85 85
Summary by CodeRabbit
New Features
Chores