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

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 CI for ultralytics/mkdocs repository with automated link checks and status badge addition.

📊 Key Changes

  • 🔄 Updated the .github/workflows/format.yml file to include a links: true option.
  • 🔑 Added token: ${{ secrets.GITHUB_TOKEN }} to allow necessary permissions for GitHub Actions.
  • 📈 Included a new status badge in the README.md for visual tracking of format workflow.

🎯 Purpose & Impact

  • 🚀 The links: true option aims to automatically validate hyperlinks, ensuring all links in documentation are functional.
  • 🛡️ The GITHUB_TOKEN addition provides secure automated access for formatting action.
  • 🌐 The README status badge offers immediate visibility of the workflow's health, enhancing transparency and trust for users.
  • 💡 Potential impact includes smoother CI processes, improved documentation reliability, and up-to-date feedback on code quality for contributors and users.

@glenn-jocher glenn-jocher merged commit 9ec8cdc into main Jan 8, 2024
2 checks passed
@glenn-jocher glenn-jocher deleted the update-format-workflow-20240108002500 branch January 8, 2024 00:37
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