![]() ![]() # The `workflow_dispatch` event lets you manually run this workflow from the UI. name: Check all English links # Defines the `workflow_dispatch` and `scheduled` as triggers for the workflow. # This defines the name of the workflow as it will appear in the "Actions" tab of the GitHub repository. These variables will be referenced later in the workflow. # Creates custom environment variables, and redefines the built-in `GITHUB_TOKEN` variable to use a custom (/actions/security-guides/using-secrets-in-github-actions). For syntax examples using other runners, see "(/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on)." This means that the job will execute on a fresh virtual machine hosted by GitHub. # Configures the job to run on an Ubuntu Linux runner. If: github.repository = 'github/docs-internal' Otherwise, the job is marked as _skipped_. # Only run the `check_all_english_links` job if the repository is named `docs-internal` and is within the `github` organization. # Defines a job with the ID `check_all_english_links`, and the name `Check all links`, that is stored within the `jobs` key. # Groups together all the jobs that run in the workflow file. For more information, see "(/actions/using-jobs/assigning-permissions-to-jobs)." This will vary depending on the needs of your workflow. # Modifies the default permissions granted to `GITHUB_TOKEN`. For more information, see (/actions/using-workflows/events-that-trigger-workflows#schedule). # The `schedule` event lets you use `cron` syntax to define a regular interval for automatically triggering the workflow. For more information, see (/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch). # Defines the `workflow_dispatch` and `scheduled` as triggers for the workflow. The following workflow checks all English links one time per day and reports broken links by creating a new issue for the docs content team to review.īeside Inline # This defines the name of the workflow as it will appear in the "Actions" tab of the GitHub repository. To review the latest version of this file in the github/docs repository, see check-all-english-links.yml. The following workflow was created by the GitHub Docs Engineering team. Preventing a job from running unless specific conditions are metĬhecking for existing issues using GitHub CLI The example workflow demonstrates the following capabilities of GitHub Actions. The following diagram shows a high level view of the workflow's steps and how they run within the job: If any broken links are found, the workflow uses the GitHub CLI to create a GitHub issue with the details. When this workflow is triggered, it automatically runs a script that checks whether the GitHub Docs site has any broken links. This article uses an example workflow to demonstrate some of the main CI features of GitHub Actions. You can see more information about planned future support on the GitHub public roadmap. Note: GitHub-hosted runners are not currently supported on GitHub Enterprise Server.
0 Comments
Leave a Reply. |
Details
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |