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

Update format.yml #63

Closed

Conversation

UltralyticsAssistant
Copy link
Member

@UltralyticsAssistant UltralyticsAssistant commented Jan 1, 2024

This pull request adds an improved Ultralytics Actions workflow to automatically format code and documentation to the new Ultralytics official standards maintained at https://github.com/ultralytics/actions.

Four individual actions are run by default. To disable actions, set them to false, i.e. 'python: false'.

To customize an action use a pyproject.toml file in this repo, and see the individual action repo for details.

name: Ultralytics Actions

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  format:
    runs-on: ubuntu-latest
    steps:
      - name: Run Ultralytics Formatting
        uses: ultralytics/actions@main
        with:
          python: true
          docstrings: true
          markdown: true
          spelling: true

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Automatic code formatting checks added to the GitHub repository.

📊 Key Changes

  • Added a new GitHub Actions workflow file format.yml for automated code and documentation formatting.
  • Removed the pre-commit configuration file .pre-commit-config.yaml.
  • Updates to markdown and Python files for syntax consistency and cleanup.
  • Refined the README.md and other documentation markdown files.
  • Minor code adjustments in Python files to follow consistent formatting.

🎯 Purpose & Impact

  • The new workflow will ensure that all code and documentation follow Ultralytics' official standards.
  • Removing pre-commit configuration files suggests a shift from local hooks to fully integrated GitHub Actions for formatting.
  • Documentation and README updates improve clarity, which benefits users by making the information more accessible and easier to understand.
  • Impact on developers includes adherence to coding standards and reduced manual formatting efforts, enhancing code maintainability.
  • Impact on users is indirect, through better and more consistently formatted documentation.

@glenn-jocher
Copy link
Member

glenn-jocher commented Jan 2, 2024

@kalenmike I've removed pre-commit from this repo and deleted the associated yaml and cfg files. Switchover to Ultralytics Actions is complete here.

@glenn-jocher glenn-jocher changed the base branch from main to develop January 2, 2024 12:37
@glenn-jocher
Copy link
Member

Closing to re-open for develop branch.

@glenn-jocher glenn-jocher deleted the update-format-workflow-20240101224621 branch January 2, 2024 12:37
@kalenmike
Copy link
Member

@glenn-jocher This is already pointed at develop?

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.

None yet

3 participants