feat(ruby): add ci.yml generation for GitHub output mode #10750
+119
−2
Conversation
This file contains hidden or 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
Add support for generating GitHub Actions CI workflow file for ruby-v2 generator. The ci.yml includes jobs for compiling, testing, and optionally publishing gems to RubyGems. Changes: - Add github-ci.yml template in ruby-v2/base/src/asIs/ - Update AsIs.ts to reference the new ci.yml template - Implement generateGithubWorkflow method in SdkGeneratorCli.ts - Support building and publishing gems with configurable registry URL and API key Co-Authored-By: [email protected] <[email protected]>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
tjb9dc
changed the title
Export getAsIsFilepath function from ruby-base package to properly resolve asIs template file paths. This fixes the ENOENT error when trying to read the github-ci.yml template during generation. The issue was caused by __dirname being resolved incorrectly in the bundled CLI when trying to reach across packages from sdk to base. The solution is to export the path resolver from the base package where the asIs files live. Co-Authored-By: [email protected] <[email protected]>
devin-ai-integration
bot
changed the title
- Remove GithubCiYml from AsIsFiles to prevent it from being copied into generated SDKs - Fix lodash template syntax error by building GitHub Actions expression in TypeScript - Update SdkGeneratorCli.ts to use getAsIsFilepath with string directly - Change gemHostApiKeyEnvVar template variable to gemHostApiKeySecret with full expression This fixes the seed test failures caused by including the CI template in AsIsFiles, which caused RubyProject to copy it into generated gems. Co-Authored-By: [email protected] <[email protected]>
devin-ai-integration
bot
changed the title
…Variable
Use trim() and || operator instead of ?? to properly fallback to defaults
when publishInfo fields are empty strings (as they are in seed configs).
This prevents generating invalid GitHub Actions expressions like:
- GEM_HOST_API_KEY: ${{ secrets. }}
- gem push --host (empty host)
Co-Authored-By: [email protected] <[email protected]>
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.
Description
Linear ticket: N/A
Requested by: [email protected] (@tjb9dc)
Devin session: https://app.devin.ai/sessions/48add64d3495483da835df980f051ae0
Adds GitHub Actions CI workflow generation for the ruby-v2 SDK generator when using GitHub output mode. The workflow includes compile, test, and optional publish jobs for Ruby gems, following the same pattern as other language generators (Python, Go, C#, PHP).
Changes Made
getAsIsFilepath()helper function toAsIs.tsfor resolving template file paths in bundled CLI environmentsgithub-ci.ymltemplate with lodash template syntax for variable substitutiongenerateGithubWorkflow()method inSdkGeneratorCli.tsto:.github/workflows/ci.ymlin the output directoryregistryUrlandapiKeyEnvironmentVariableusing.trim() || defaultValuepatternKey Implementation Details
Path Resolution: The
getAsIsFilepath()function is exported from the base package to ensure__dirnameresolves correctly in bundled CLI environments where cross-package path resolution can fail.Template Variables:
gemName: The root folder name of the generated SDKshouldWritePublishBlock: Boolean flag to conditionally include the publish jobregistryUrl: The gem registry URL (defaults to rubygems.org)gemHostApiKeySecret: Pre-computed GitHub Actions secret expression (e.g.,${{ secrets.RUBYGEMS_AUTH_TOKEN }})Critical Fix: The
gemHostApiKeySecretis computed in TypeScript as${{ secrets.${gemHostApiKeyEnvVar} }}to avoid nested template syntax that would break lodash compilation. Empty strings are handled with.trim() || defaultValueto prevent generating invalid expressions like${{ secrets. }}.Testing
pnpm run check)Human Review Checklist
github-ci.ymlis correct, especially:<% if (shouldWritePublishBlock) { %><%= gemName %>,<%= gemHostApiKeySecret %>, etc..trim() || defaultValue) properly falls back to defaults when publishInfo fields are empty${{ secrets.${envVar} }}is properly escapedgetAsIsFilepath()works correctly in both local and bundled CLI environments