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

Add Prettier formatting for markdown and YAML files #53

Merged
merged 95 commits into from
Jan 18, 2024
Merged

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Jan 14, 2024

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Update to Ultralytics Actions for better code and docs formatting.

📊 Key Changes

  • Expanded trigger branches to include both main and master.
  • Removed specific markdown and docstring formatting in favor of prettier, which supports a wider range of files.
  • Streamlined Python formatting by combining ruff and docformatter commands.
  • Updated documentation and examples to reflect the new configuration.
  • Added npm install and execution of prettier to format various file types.
  • Updated commit messages for clarity.
  • Excluded workflow changes from being pushed by the default GitHub token.

🎯 Purpose & Impact

  • Broader Reach: The inclusion of both main and master branches ensures more repositories can utilize the workflow without additional customizations.
  • Enhanced Formatting: Using prettier allows for consistent and wide-ranging formatting capabilities across file types, leading to cleaner and more professional codebases.
  • Developer Efficiency: Simplified Python formatting steps reduce complexity and potential errors during code submission.
  • Improved Documentation: Cleaner and updated documentation makes it easier for new users to adopt the actions, improving the user experience.
  • Safer Operations: Preventing the workflow from committing its changes with a default token prevents potential security risks and accidental misconfigurations.

@glenn-jocher glenn-jocher changed the title Test prettier formatting for markdown and YAML files Add Prettier formatting for markdown and YAML files Jan 18, 2024
@glenn-jocher glenn-jocher merged commit 575f488 into main Jan 18, 2024
1 check passed
@glenn-jocher glenn-jocher deleted the prettier branch January 18, 2024 20:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants