Skip to content
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

fix: Made Automatic generation of github action workflow for keploy configurable #1784

Merged
merged 6 commits into from
Apr 8, 2024

Conversation

Akash-Singh04
Copy link
Contributor

Related Issue

  • This fix was made to ensure the github actions file is not unnecessarily made via adding CLI Flag to enable/disable it (default:true)

Closes: #1780

Describe the changes you've made

  • Added --generateGithubActions flag to CLI and Config to enable/disable Automatic generation of github action workflow for keploy (default:true)
  • Disabled generation of github action workflow for keploy for test commands to avoid unnecessarily making this workflow file.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Code style update (formatting, local variables)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Please let us know if any test cases are added

NIL
Please describe the tests(if any). Provide instructions how its affecting the coverage.
NIL

Describe if there is any unusual behaviour of your code(Write NA if there isn't)

NA
A clear and concise description of it.

Checklist:

  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.

Screenshots (if any)

image

…ly in record mode

Signed-off-by: Akash Singh <akashsingh2210670@gmail.com>
@Akash-Singh04
Copy link
Contributor Author

Kindly review this @gouravkrosx

@gouravkrosx
Copy link
Member

@Akash-Singh04 Please update the pipeline as well, in the testing pipeline it should be false.

@Akash-Singh04
Copy link
Contributor Author

@gouravkrosx Which Testing pipeline are you referring to? Is it the Github Actions workflow ? Apologies for the confusion

@gouravkrosx
Copy link
Member

@Akash-Singh04 Yes in all the workflows, it should be false.

Signed-off-by: Akash Singh <akashsingh2210670@gmail.com>
@Akash-Singh04
Copy link
Contributor Author

@gouravkrosx Do review this and let me know if i have missed anything


defer utils.GenerateGithubActions(c.logger, c.cfg.Command)

if cmd.Name() == "record" && c.cfg.GenerateGithubActions {
Copy link
Member

Choose a reason for hiding this comment

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

I think it should be independent of the command, if the user has recorded test cases from an older version of keploy and now upgraded the version but directly using the test mode then in that case also keploy should generate the GitHub action.

@Akash-Singh04
Copy link
Contributor Author

@gouravkrosx Your requested changes have been made

Signed-off-by: Akash Singh <akashsingh2210670@gmail.com>
@gouravkrosx
Copy link
Member

LGTM!

@gouravkrosx gouravkrosx merged commit 3b51498 into keploy:main Apr 8, 2024
14 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Apr 8, 2024
@Akash-Singh04 Akash-Singh04 deleted the generategithubactionsflag branch April 24, 2024 15:02
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

fix: automatic generation of github action workflow for keploy should be configurable
2 participants