Skip to content
This repository has been archived by the owner on Mar 18, 2024. It is now read-only.

1430: Update example commands and typos #1431

Merged
merged 1 commit into from
Oct 26, 2023

Conversation

crazynammer
Copy link
Contributor

@crazynammer crazynammer commented Oct 26, 2023

Summary generated by Reviewpad on 26 Oct 23 00:16 UTC

This pull request updates example commands and fixes typos in the release definition generation feature. The command description, flag descriptions, and examples have been corrected and improved. Specifically, the release name flag description has been updated, and the typos in the command and flag descriptions have been fixed. Additionally, the examples now include the necessary flags for specifying the release name, git reference, and config file.

Checklist

All items have to be completed before a PR is merged

  • Adhere to Contribution Guidelines
  • Updates to Decision Records considered?
  • Updates to documentation at DX@Scale Guide considered?
  • Tested changes?
  • Unit Tests new and existing passing locally?

@crazynammer crazynammer added the documentation Improvements or additions to documentation label Oct 26, 2023
@reviewpad
Copy link

reviewpad bot commented Oct 26, 2023

Thank you @crazynammer for this first contribution!

@reviewpad reviewpad bot added small Pull request is small waiting-for-review labels Oct 26, 2023
@reviewpad
Copy link

reviewpad bot commented Oct 26, 2023

Reviewpad Report

‼️ Errors

  • Unconventional commit detected: '1430: Update example commands and typos' (f6b6562)
  • Unconventional title detected: '1430: Update example commands and typos' illegal '1' character in commit message type: col=00

@codecov
Copy link

codecov bot commented Oct 26, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (78cab45) 46.86% compared to head (a7e8060) 46.86%.

❗ Current head a7e8060 differs from pull request most recent head f6b6562. Consider uploading reports for the commit f6b6562 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1431   +/-   ##
=======================================
  Coverage   46.86%   46.86%           
=======================================
  Files          70       70           
  Lines        2665     2665           
  Branches      313      313           
=======================================
  Hits         1249     1249           
  Misses       1386     1386           
  Partials       30       30           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@azlam-abdulsalam azlam-abdulsalam left a comment

Choose a reason for hiding this comment

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

Thanks @crazynammer

@azlam-abdulsalam azlam-abdulsalam merged commit b56ec85 into main Oct 26, 2023
4 of 5 checks passed
@azlam-abdulsalam azlam-abdulsalam deleted the issue/1430-releasedefinition branch October 26, 2023 01:42
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation small Pull request is small waiting-for-review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Example commands for "sfp releasedefinition:generate" missing (required) fields
2 participants