Skip to content

Commit

Permalink
Improve Actions short titles (github#31394)
Browse files Browse the repository at this point in the history
Co-authored-by: Martin Lopes <[email protected]>
  • Loading branch information
lucascosti and Martin Lopes authored Oct 5, 2022
1 parent 34a7be5 commit 7b86410
Show file tree
Hide file tree
Showing 75 changed files with 75 additions and 61 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Creating a composite action
shortTitle: Create a composite action
intro: 'In this guide, you''ll learn how to build a composite action.'
redirect_from:
- /actions/creating-actions/creating-a-composite-run-steps-action
Expand All @@ -11,7 +12,6 @@ versions:
type: tutorial
topics:
- Action development
shortTitle: Composite action
---

{% data reusables.actions.enterprise-beta %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Creating a Docker container action
shortTitle: Create a Docker container action
intro: 'This guide shows you the minimal steps required to build a Docker container action. '
redirect_from:
- /articles/creating-a-docker-container-action
Expand All @@ -15,7 +16,6 @@ type: tutorial
topics:
- Action development
- Docker
shortTitle: Docker container action
---

{% data reusables.actions.enterprise-beta %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Creating a JavaScript action
shortTitle: Create a JavaScript action
intro: 'In this guide, you''ll learn how to build a JavaScript action using the actions toolkit.'
redirect_from:
- /articles/creating-a-javascript-action
Expand All @@ -15,7 +16,6 @@ type: tutorial
topics:
- Action development
- JavaScript
shortTitle: JavaScript action
---

{% data reusables.actions.enterprise-beta %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Releasing and maintaining actions
shortTitle: Releasing and maintaining actions
shortTitle: Release and maintain actions
intro: You can leverage automation and open source best practices to release and maintain actions.
type: tutorial
topics:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Setting exit codes for actions
shortTitle: Setting exit codes
shortTitle: Set exit codes
intro: 'You can use exit codes to set the status of an action. {% data variables.product.prodname_dotcom %} displays statuses to indicate passing or failing actions.'
redirect_from:
- /actions/building-actions/setting-exit-codes-for-actions
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Deploying to your cloud provider
shortTitle: Deploying to your cloud provider
shortTitle: Deploy to your cloud provider
intro: 'You can deploy to various cloud providers, such as AWS, Azure, and GKE.'
versions:
fpt: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Deploying Xcode applications
shortTitle: Deploying Xcode applications
shortTitle: Deploy Xcode applications
intro: 'You can sign Xcode apps within your continuous integration (CI) workflow by installing an Apple code signing certificate on {% data variables.product.prodname_actions %} runners.'
versions:
fpt: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Installing an Apple certificate on macOS runners for Xcode development
shortTitle: Sign Xcode applications
intro: 'You can sign Xcode apps within your continuous integration (CI) workflow by installing an Apple code signing certificate on {% data variables.product.prodname_actions %} runners.'
redirect_from:
- /actions/guides/installing-an-apple-certificate-on-macos-runners-for-xcode-development
Expand All @@ -13,7 +14,6 @@ type: tutorial
topics:
- CI
- Xcode
shortTitle: Sign Xcode applications
---

{% data reusables.actions.enterprise-beta %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Managing your deployments
shortTitle: Managing your deployments
shortTitle: Manage your deployments
intro: You can review the past activity of your deployments.
versions:
fpt: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Viewing deployment history
shortTitle: View deployment history
intro: View current and previous deployments for your repository.
versions:
fpt: '*'
Expand All @@ -8,7 +9,6 @@ versions:
ghec: '*'
topics:
- API
shortTitle: View deployment history
redirect_from:
- /developers/overview/viewing-deployment-history
- /actions/deployment/viewing-deployment-history
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: About security hardening with OpenID Connect
shortTitle: About security hardening with OpenID Connect
shortTitle: Security hardening with OpenID Connect
intro: OpenID Connect allows your workflows to exchange short-lived tokens directly from your cloud provider.
miniTocMaxHeadingLevel: 4
versions:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Configuring OpenID Connect in Amazon Web Services
shortTitle: Configuring OpenID Connect in Amazon Web Services
shortTitle: OpenID Connect in AWS
intro: Use OpenID Connect within your workflows to authenticate with Amazon Web Services.
miniTocMaxHeadingLevel: 3
versions:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Configuring OpenID Connect in Azure
shortTitle: Configuring OpenID Connect in Azure
shortTitle: OpenID Connect in Azure
intro: Use OpenID Connect within your workflows to authenticate with Azure.
miniTocMaxHeadingLevel: 3
versions:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Configuring OpenID Connect in cloud providers
shortTitle: Configuring OpenID Connect in cloud providers
shortTitle: OpenID Connect in cloud providers
intro: Use OpenID Connect within your workflows to authenticate with cloud providers.
miniTocMaxHeadingLevel: 3
versions:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Configuring OpenID Connect in Google Cloud Platform
shortTitle: Configuring OpenID Connect in Google Cloud Platform
shortTitle: OpenID Connect in Google Cloud Platform
intro: Use OpenID Connect within your workflows to authenticate with Google Cloud Platform.
miniTocMaxHeadingLevel: 3
versions:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Configuring OpenID Connect in HashiCorp Vault
shortTitle: Configuring OpenID Connect in HashiCorp Vault
shortTitle: OpenID Connect in HashiCorp Vault
intro: Use OpenID Connect within your workflows to authenticate with HashiCorp Vault.
miniTocMaxHeadingLevel: 3
versions:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Security hardening your deployments
shortTitle: Security hardening your deployments
shortTitle: Security harden deployments
intro: Use OpenID Connect within your workflows to authenticate with your cloud provider.
versions:
fpt: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Using OpenID Connect with reusable workflows
shortTitle: Using OpenID Connect with reusable workflows
shortTitle: OpenID Connect with reusable workflows
intro: You can use reusable workflows with OIDC to standardize and security harden your deployment steps.
miniTocMaxHeadingLevel: 3
redirect_from:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Targeting different environments
shortTitle: Targeting different environments
shortTitle: Target different environments
intro: You can configure environments with protection rules and secrets. A workflow job that references an environment must follow any protection rules for the environment before running or accessing the environment's secrets.
versions:
fpt: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Using concurrency, expressions, and a test matrix'
shortTitle: 'Using concurrency, expressions, and a test matrix'
shortTitle: 'Use concurrency, expressions, and a test matrix'
intro: 'How to use advanced {% data variables.product.prodname_actions %} features for continuous integration (CI).'
versions:
fpt: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Using scripts to test your code on a runner
shortTitle: Using scripts to test your code on a runner
shortTitle: Use scripts to test your code on a runner
intro: 'How to use essential {% data variables.product.prodname_actions %} features for continuous integration (CI).'
versions:
fpt: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Using the GitHub CLI on a runner
shortTitle: Using the GitHub CLI on a runner
shortTitle: Use the GitHub CLI on a runner
intro: 'How to use advanced {% data variables.product.prodname_actions %} features for continuous integration (CI).'
versions:
fpt: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Autoscaling with self-hosted runners
shortTitle: Autoscale self-hosted runners
intro: You can automatically scale your self-hosted runners in response to webhook events.
versions:
fpt: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Configuring the self-hosted runner application as a service
shortTitle: Run the runner app as a service
intro: You can configure the self-hosted runner application as a service to automatically start the runner application when the machine starts.
redirect_from:
- /actions/automating-your-workflow-with-github-actions/configuring-the-self-hosted-runner-application-as-a-service
Expand All @@ -10,7 +11,6 @@ versions:
ghec: '*'
type: tutorial
defaultPlatform: linux
shortTitle: Run runner app on startup
---

{% data reusables.actions.enterprise-beta %}
Expand Down
1 change: 1 addition & 0 deletions content/actions/hosting-your-own-runners/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Hosting your own runners
shortTitle: Self-hosted runners
intro: You can create self-hosted runners to run workflows in a highly customizable environment.
redirect_from:
- /github/automating-your-workflow-with-github-actions/hosting-your-own-runners
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Managing access to self-hosted runners using groups
shortTitle: Manage access with runner groups
intro: You can use policies to limit access to self-hosted runners that have been added to an organization or enterprise.
redirect_from:
- /actions/hosting-your-own-runners/managing-access-to-self-hosted-runners
Expand All @@ -9,7 +10,6 @@ versions:
ghae: '*'
ghec: '*'
type: tutorial
shortTitle: Using runner groups
---

{% data reusables.actions.enterprise-beta %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Finding and customizing actions
shortTitle: Finding and customizing actions
shortTitle: Find and customize actions
intro: 'Actions are the building blocks that power your workflow. A workflow can contain actions created by the community, or you can create your own actions directly within your application''s repository. This guide will show you how to discover, use, and customize actions.'
redirect_from:
- /actions/automating-your-workflow-with-github-actions/using-github-marketplace-actions
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Understanding GitHub Actions
shortTitle: Understanding GitHub Actions
shortTitle: Understand GitHub Actions
intro: 'Learn the basics of {% data variables.product.prodname_actions %}, including core concepts and essential terminology.'
miniTocMaxHeadingLevel: 3
redirect_from:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Adding labels to issues
shortTitle: Add labels to issues
intro: 'You can use {% data variables.product.prodname_actions %} to automatically label issues.'
redirect_from:
- /actions/guides/adding-labels-to-issues
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Closing inactive issues
shortTitle: Close inactive issues
intro: 'You can use {% data variables.product.prodname_actions %} to comment on or close issues that have been inactive for a certain period of time.'
redirect_from:
- /actions/guides/closing-inactive-issues
Expand Down
2 changes: 1 addition & 1 deletion content/actions/managing-issues-and-pull-requests/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Managing issues and pull requests
shortTitle: Managing issues and pull requests
shortTitle: Manage issues and pull requests
intro: 'You can automatically manage your issues and pull requests using {% data variables.product.prodname_actions %} workflows.'
versions:
fpt: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Scheduling issue creation
shortTitle: Schedule issue creation
intro: 'You can use {% data variables.product.prodname_actions %} to create an issue on a regular basis for things like daily meetings or quarterly reviews.'
redirect_from:
- /actions/guides/scheduling-issue-creation
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Canceling a workflow
shortTitle: Cancel a workflow
intro: 'You can cancel a workflow run that is in progress. When you cancel a workflow run, {% data variables.product.prodname_dotcom %} cancels all jobs and steps that are a part of that workflow.'
versions:
fpt: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Deleting a workflow run
shortTitle: Delete a workflow run
intro: 'You can delete a workflow run that has been completed, or is more than two weeks old.'
versions:
fpt: '*'
Expand Down
2 changes: 1 addition & 1 deletion content/actions/managing-workflow-runs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Managing workflow runs
shortTitle: Managing workflow runs
shortTitle: Manage workflow runs
intro: 'You can re-run or cancel a workflow, {% ifversion fpt or ghes or ghae %}review deployments, {% endif %}view billable job execution minutes, and download artifacts.'
redirect_from:
- /actions/configuring-and-managing-workflows/managing-a-workflow-run
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Re-running workflows and jobs
shortTitle: Re-run workflows and jobs
intro: 'You can re-run a workflow run{% ifversion re-run-jobs %}, all failed jobs in a workflow run, or specific jobs in a workflow run{% endif %} up to 30 days after its initial run.'
permissions: People with write permissions to a repository can re-run workflows in the repository.
miniTocMaxHeadingLevel: 3
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Reviewing deployments
shortTitle: Review deployments
intro: You can approve or reject jobs awaiting review.
product: '{% data reusables.gated-features.environments %}'
versions:
Expand Down
2 changes: 1 addition & 1 deletion content/actions/migrating-to-github-actions/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Migrating to GitHub Actions
shortTitle: Migrating to GitHub Actions
shortTitle: Migrate to GitHub Actions
intro: 'Learn how to migrate your existing CI/CD workflows to {% data variables.product.prodname_actions %}.'
versions:
fpt: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Adding a workflow status badge
shortTitle: Add a status badge
intro: You can display a status badge in your repository to indicate the status of your workflows.
redirect_from:
- /actions/managing-workflow-runs/adding-a-workflow-status-badge
Expand All @@ -8,7 +9,6 @@ versions:
ghes: '*'
ghae: '*'
ghec: '*'
shortTitle: Add a status badge
---

{% data reusables.actions.enterprise-beta %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Enabling debug logging
shortTitle: Enable debug logging
intro: 'If the workflow logs do not provide enough detail to diagnose why a workflow, job, or step is not working as expected, you can enable additional debug logging.'
redirect_from:
- /actions/managing-workflow-runs/enabling-debug-logging
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Notifications for workflow runs
shortTitle: Notifications for workflow runs
intro: You can subscribe to notifications about workflow runs that you trigger.
versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
shortTitle: Notifications
---

{% data reusables.actions.enterprise-beta %}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Using the visualization graph
shortTitle: Visualization graph
intro: Every workflow run generates a real-time graph that illustrates the run progress. You can use this graph to monitor and debug workflows.
redirect_from:
- /actions/managing-workflow-runs/using-the-visualization-graph
Expand All @@ -8,7 +9,6 @@ versions:
ghes: '*'
ghae: '*'
ghec: '*'
shortTitle: Use the visualization graph
---

{% data reusables.actions.enterprise-beta %}
Expand Down
Loading

0 comments on commit 7b86410

Please sign in to comment.