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 Actions with Lychee and GitHub Token #34

Merged
merged 2 commits into from
Jan 8, 2024

Conversation

pderrenger
Copy link
Member

@pderrenger pderrenger commented Jan 7, 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.

Five individual actions are run by default now including a new broken links check for markdown and HTML files. Disable individual actions by setting them to false or removing their line, i.e. delete 'markdown: true' line to disable markdown formatting.

To customize an action use a pyproject.toml file in this repo. For details see https://github.com/ultralytics/actions.

# Ultralytics πŸš€ - AGPL-3.0 license
# Ultralytics Actions https://github.com/ultralytics/actions
# This workflow automatically formats code and documentation in PRs to official Ultralytics standards

name: Ultralytics Actions

on:
  push:
    branches: [main]
  pull_request_target:
    branches: [main]

jobs:
  format:
    runs-on: ubuntu-latest
    steps:
      - name: Run Ultralytics Formatting
        uses: ultralytics/actions@main
        with:
          token: ${{ secrets.GITHUB_TOKEN }}  # automatically generated
          python: true
          docstrings: true
          markdown: true
          spelling: true
          links: true

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Automated formatting improvements and README badge addition for Ultralytics Assets repo.

πŸ“Š Key Changes

  • Enhanced the GitHub Actions formatting workflow with a links check.
  • Included a GitHub Actions status badge in the README file.

🎯 Purpose & Impact

  • Purpose: To ensure the quality of documentation with automated checks for link validity and to signal to the repository viewers the status of the repository's code health.
  • Impact: Provides immediate visual feedback on the code’s formatting status, encourages best practices, and potentially increases user trust due to transparent quality control. πŸ’ͺπŸ”—βœ…

@glenn-jocher glenn-jocher merged commit 6146984 into main Jan 8, 2024
1 check passed
@glenn-jocher glenn-jocher deleted the update-format-workflow-20240108002409 branch January 8, 2024 00:35
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

2 participants