Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ The `README.md` file is often the first place developers will look at to see how

As a general rule, the `README.md` file should include everything a user should know to use the action. If you think it could be useful information, include it in the `README.md`.

GitHub Actions lets you generate markdown files and publish them as a job summary. Using the same familiar functionality that powers pull requests and issues, an action can generate custom Markdown content on the run summary generated by each job.

## Release and version your action

If you're developing an action for other people to use, regardless of if it's public or private, you should define a release management strategy to control how updates are distributed. Major version updates including necessary critical fixes and security patches that affect compatibility need to be documented clearly.
Expand All @@ -37,6 +39,8 @@ If you're developing an action for other people to use, regardless of if it's pu

A good release management strategy should include versioning recommendations. Users should not be referencing an action's default branch with the action as the default branch which is likely to contain the latest code (which may or may not be stable) and could result in your workflow breaking. Instead, we recommend that users specify a major version when using the action, and to only direct them to a more specific version if they encounter issues. This can be done by configuring their GitHub Actions workflow to target a tag, a commit's SHA, or a specific branch named for a release. Let's take a closer look at these release options.

GitHub has made changes to better support communities who have chosen to move away from using `master` as their default branch name. This update has been applied to all of the starter workflows that use a new `$default-branch` macro. You can take advantage of this feature in your custom starter workflow templates as well. In addition, GitHub has renamed the default branch for most of the GitHub-authored actions from `master` to `main`. All of your workflows that reference the old branch name will still work, but you’ll see a prompt to change to the new name when you edit the workflow using the GitHub UI.

#### Tags

Tags can be a good way to manage releases for an action. By using tags, users can easily distinguish between major and minor versions. Below is a list of helpful practices to consider when creating releases:
Expand Down
2 changes: 1 addition & 1 deletion github/create-custom-github-actions/index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ uid: learn.github.create-custom-github-actions
metadata:
title: Create and publish custom GitHub actions
description: Learn how to create and publish custom GitHub actions.
ms.date: 07/08/2022
ms.date: 08/08/2022
author: a-a-ron
ms.author: aastewar
ms.topic: interactive-tutorial
Expand Down