Skip to content

fix the output directory so that the pipeline works #11

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

Merged
merged 1 commit into from
Apr 30, 2025

Conversation

gumaerc
Copy link
Contributor

@gumaerc gumaerc commented Apr 30, 2025

What are the relevant tickets?

Closes https://github.com/mitodl/hq/issues/7217

Description (What does it do?)

This PR corrects the outputDir setting in the config to point at mitxonline-api-clients instead of mitxonline-clients, because that's where the pipeline that publishes the library expects the output artifacts to be.

How can this be tested?

This needs to be tested by running the pipeline in production and making sure it picks up the artficts in the publish job

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Hello @gumaerc, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

This pull request addresses issue #7217 by correcting the outputDir setting in the config/typescript-axios-v0.yaml file. The change ensures that the pipeline correctly picks up the generated artifacts by pointing the output directory to mitxonline-api-clients instead of the previous mitxonline-clients. This correction is crucial for the proper functioning of the library publishing pipeline.

Highlights

  • Configuration Fix: The primary change involves updating the outputDir in config/typescript-axios-v0.yaml to ensure the pipeline publishes artifacts to the correct directory.
  • Pipeline Alignment: This change directly supports the pipeline's expectations for artifact location, resolving a discrepancy that was preventing successful publishing.

Changelog

  • config/typescript-axios-v0.yaml
    • Updated outputDir from mitxonline-clients/src/typescript/mitxonline-api-axios/src/v0 to mitxonline-api-clients/src/typescript/mitxonline-api-axios/src/v0 to align with the pipeline's expected output location.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.


A path was wrong, a build did fail,
The output lost, a mournful wail.
But now it's fixed, the pipeline sings,
As artifacts land where it brings.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request corrects the output directory for the generated API clients, which is necessary for the pipeline to function correctly. The change itself is straightforward and addresses the identified issue.

Merge Readiness

The pull request appears to be ready for merging, as it directly addresses the identified issue and the change is simple and well-defined. I am unable to directly approve the pull request, and other reviewers should review and approve this code before merging.

@@ -1,5 +1,5 @@
generatorName: typescript-axios
outputDir: mitxonline-clients/src/typescript/mitxonline-api-axios/src/v0
outputDir: mitxonline-api-clients/src/typescript/mitxonline-api-axios/src/v0

Choose a reason for hiding this comment

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

medium

This change corrects the output directory. Double-check that mitxonline-api-clients is indeed the correct location for the pipeline to pick up the artifacts.

@gumaerc gumaerc added the Needs Review An open Pull Request that is ready for review label Apr 30, 2025
Copy link

@jkachel jkachel left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@gumaerc gumaerc merged commit 857b4d4 into main Apr 30, 2025
1 check passed
gumaerc added a commit that referenced this pull request Apr 30, 2025
gumaerc added a commit that referenced this pull request Apr 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs Review An open Pull Request that is ready for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants