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 #13

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

Enhanced GitHub Actions and improved repository documentation.

📊 Key Changes

  • GitHub Actions now trigger on pushes and pull requests to both main and master branches.
  • A new links check is included in the formatting GitHub Actions workflow.
  • A status badge for GitHub Actions has been added to the README.

🎯 Purpose & Impact

  • 🔄 Dual Branch Support: Including both main and master branches for actions ensures compatibility with repositories using either naming convention, making the template more versatile.
  • 🔗 Links Validation: The links validation will help maintain the integrity and reliability of external references in the project's documentation.
  • 📈 Visibility of Actions Status: The badge in the README allows users to quickly see the status of these formatting actions, increasing transparency and trust in the repository's maintenance practices.

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