diff --git a/assets/images/help/issues/attach-file.png b/assets/images/help/issues/attach-file.png new file mode 100644 index 000000000000..b375c12699ce Binary files /dev/null and b/assets/images/help/issues/attach-file.png differ diff --git a/assets/images/help/pull_requests/attach-file.png b/assets/images/help/pull_requests/attach-file.png new file mode 100644 index 000000000000..665723ad821e Binary files /dev/null and b/assets/images/help/pull_requests/attach-file.png differ diff --git a/content/actions/concepts/workflows-and-actions/about-custom-actions.md b/content/actions/concepts/workflows-and-actions/about-custom-actions.md index f561bed5743d..2cc0243fb694 100644 --- a/content/actions/concepts/workflows-and-actions/about-custom-actions.md +++ b/content/actions/concepts/workflows-and-actions/about-custom-actions.md @@ -33,7 +33,7 @@ Actions can run directly on a machine or in a Docker container. You can define a ## Types of actions -You can build Docker container, JavaScript, and composite actions. Actions require a metadata file to define the inputs, outputs and main entrypoint for your action. The metadata filename must be `action.yml`. For more information, see [AUTOTITLE](/actions/creating-actions/metadata-syntax-for-github-actions). +{% data reusables.actions.types-of-actions %} {% rowheaders %} diff --git a/content/actions/reference/index.md b/content/actions/reference/index.md index 53fa0fb84399..d03443a4efb7 100644 --- a/content/actions/reference/index.md +++ b/content/actions/reference/index.md @@ -13,7 +13,7 @@ children: - /variables-reference - /evaluate-expressions-in-workflows-and-actions - /contexts-reference - - /metadata-syntax-for-github-actions + - /metadata-syntax-reference - /actions-limits - /dockerfile-support-for-github-actions - /supported-architectures-and-operating-systems-for-self-hosted-runners diff --git a/content/actions/reference/metadata-syntax-for-github-actions.md b/content/actions/reference/metadata-syntax-reference.md similarity index 97% rename from content/actions/reference/metadata-syntax-for-github-actions.md rename to content/actions/reference/metadata-syntax-reference.md index 662c0fd1938f..4a03b83059d1 100644 --- a/content/actions/reference/metadata-syntax-for-github-actions.md +++ b/content/actions/reference/metadata-syntax-reference.md @@ -1,5 +1,5 @@ --- -title: Metadata syntax for GitHub Actions +title: Metadata syntax reference shortTitle: Metadata syntax intro: You can create actions to perform tasks in your repository. Actions require a metadata file that uses YAML syntax. redirect_from: @@ -9,20 +9,16 @@ redirect_from: - /actions/building-actions/metadata-syntax-for-github-actions - /actions/creating-actions/metadata-syntax-for-github-actions - /actions/sharing-automations/creating-actions/metadata-syntax-for-github-actions + - /actions/reference/metadata-syntax-for-github-actions versions: fpt: '*' ghes: '*' ghec: '*' type: reference +allowTitleToDifferFromFilename: true --- -{% data reusables.actions.enterprise-github-hosted-runners %} - -## About YAML syntax for {% data variables.product.prodname_actions %} - -All actions require a metadata file. The metadata filename must be either `action.yml` or `action.yaml`. The preferred format is `action.yml`. The data in the metadata file defines the inputs, outputs, and runs configuration for your action. - -Action metadata files use YAML syntax. If you're new to YAML, you can read [Learn YAML in five minutes](https://www.codeproject.com/Articles/1214409/Learn-YAML-in-five-minutes). +{% data reusables.actions.types-of-actions %} ## `name` diff --git a/content/get-started/writing-on-github/working-with-advanced-formatting/attaching-files.md b/content/get-started/writing-on-github/working-with-advanced-formatting/attaching-files.md index 3e0f623be9d7..974d0d736dec 100644 --- a/content/get-started/writing-on-github/working-with-advanced-formatting/attaching-files.md +++ b/content/get-started/writing-on-github/working-with-advanced-formatting/attaching-files.md @@ -30,9 +30,14 @@ topics: {% endif %} -To attach a file to an issue or pull request conversation, drag and drop it into the comment box. Alternatively, you can click {% octicon "paperclip" aria-label="Attach files" %} in the formatting bar above the comment box to browse, select, and add a file from your computer. +To attach a file to an issue or pull request conversation, drag and drop it into the comment box. +Alternatively, you can click {% octicon "paperclip" aria-label="Attach files" %} below the issue comment box to browse, select, and add a file from your computer. -![Screenshot of the comment box. The "Attach files" icon is outlined in orange.](/assets/images/help/issues/attach-file-icon.png) +![Screenshot of the issue comment box. The "Attach files" icon is outlined in orange.](/assets/images/help/issues/attach-file.png) + +For a pull request, you can also click {% octicon "paperclip" aria-label="Attach files" %} in the formatting bar above the pull request comment box. + +![Screenshot of the pull request comment box. The "Attach files" icon is outlined in orange.](/assets/images/help/pull_requests/attach-file.png) When you attach a file, it is uploaded immediately to {% data variables.product.github %} and the text field is updated to show the anonymized URL for the file. {% ifversion fpt or ghec %}For more information on anonymized URLs see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/about-anonymized-urls).{% endif %} @@ -50,7 +55,11 @@ The maximum file size is: > [!NOTE] > To upload videos greater than 10MB to a repository owned by a user or organization on a paid {% data variables.product.prodname_dotcom %} plan, you must either be an organization member or outside collaborator, or be on a paid plan. -We support these files: +## Supported file types + +### Image and media files + +The following image and media file types are supported in all contexts. * PNG (`.png`) * GIF (`.gif`) @@ -58,18 +67,21 @@ We support these files: {%- ifversion svg-support %} * SVG (`.svg`) {%- endif %} -* Log files (`.log`) -* Markdown files (`.md`) -* Microsoft Word (`.docx`), PowerPoint (`.pptx`), and Excel (`.xlsx`) documents -* Text files (`.txt`) -* Patch files (`.patch`) +* Video (`.mp4`, `.mov`, `.webm`) > [!NOTE] - > If you use Linux and try to upload a `.patch` file, you will receive an error message. This is a known issue. + > Video codec compatibility is browser specific, and it's possible that a video you upload to one browser is not viewable on another browser. At the moment we recommend using H.264 for greatest compatibility. + +### Additional file types + +The following file types are supported when uploading to issue and pull request comments in repositories. * PDFs (`.pdf`) -* ZIP (`.zip`, `.gz`, `.tgz`) -* Video (`.mp4`, `.mov`, `.webm`) +* Microsoft Office documents (`.docx`, `.pptx`, `.xlsx`, `.xls`) +* OpenDocument formats (`.odt`, `.fodt`, `.ods`, `.fods`, `.odp`, `.fodp`, `.odg`, `.fodg`, `.odf`) +* Text and data files (`.txt`, `.csv`, `.log`, `.md`, `.json`, `.jsonc`) +* Archive files (`.zip`, `.gz`, `.tgz`) +* Development files (`.patch`, `.cpuprofile`, `.dmp`) > [!NOTE] - > Video codec compatibility is browser specific, and it's possible that a video you upload to one browser is not viewable on another browser. At the moment we recommend using H.264 for greatest compatibility. + > If you use Linux and try to upload a `.patch` file, you will receive an error message. This is a known issue. diff --git a/data/reusables/actions/types-of-actions.md b/data/reusables/actions/types-of-actions.md new file mode 100644 index 000000000000..d04c30b9d7bc --- /dev/null +++ b/data/reusables/actions/types-of-actions.md @@ -0,0 +1,2 @@ +>[!NOTE] +> You can build Docker container, JavaScript, and composite actions. Actions require a metadata file to define the inputs, outputs, and runs configuration for your action. Action metadata files use YAML syntax, and the metadata filename must be either `action.yml` or `action.yaml`. The preferred format is `action.yml`.