Skip to content

Commit

Permalink
Merge pull request #20 from norwd/norwd-patch-1
Browse files Browse the repository at this point in the history 
Correct the comment character in the YAML example
  • Loading branch information
@norwd
norwd authored Dec 7, 2022
2 parents 7728c45 + d86f1f4 commit 02f44be
Showing 1 changed file with 37 additions and 37 deletions.
74 changes: 37 additions & 37 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,65 +55,65 @@ jobs:
- uses: norwd/fmtya@v1
with:
// Due to how GitHub's permissions system is set up, the default token
// does not have the necessary access to update workflow files. If you
// want to want `fmtya` to format the files in the `.github/workflows`
// directory, you will need to set up a PAT with at least write access
// to both the `repo` and `workflows` permissions.
# Due to how GitHub's permissions system is set up, the default token
# does not have the necessary access to update workflow files. If you
# want to want `fmtya` to format the files in the `.github/workflows`
# directory, you will need to set up a PAT with at least write access
# to both the `repo` and `workflows` permissions.
token: ${{ secrets.<YOUR_PAT> }}

// By default, `fmtya` uses the latest available version of `yamlfmt`.
// This may result changes to the behaviour of `fmtya`, for example if
// a major version of `yamlfmt` is released. If you prefer to manually
// select a specific version of `yamlfmt`, any released version can be
// pecifically requested.
# By default, `fmtya` uses the latest available version of `yamlfmt`.
# This may result changes to the behaviour of `fmtya`, for example if
# a major version of `yamlfmt` is released. If you prefer to manually
# select a specific version of `yamlfmt`, any released version can be
# pecifically requested.
yamlfmt-version: vX.Y.Z

// If there are files in your repo that follow a different convention,
// are auto-generated, or you just don't want to format for any reason
// at all, you can exclude specific files, or only selectively include
// certain files. The patterns are parsed by `yamlfmt`, and internally
// use https://github.com/bmatcuk/doublestar.
# If there are files in your repo that follow a different convention,
# are auto-generated, or you just don't want to format for any reason
# at all, you can exclude specific files, or only selectively include
# certain files. The patterns are parsed by `yamlfmt`, and internally
# use https://github.com/bmatcuk/doublestar.
exclude-files: test/data/*.{yaml,yml}
include-files: |
**/*.{yaml,yml}
.yamlfmt
// Specific formatting options to configure the size of indents, or if
// yaml anchors or aliases should or shouldn't be allowed, can be used
// to control how yamlfmt formats the files in your repository.
# Specific formatting options to configure the size of indents, or if
# yaml anchors or aliases should or shouldn't be allowed, can be used
# to control how yamlfmt formats the files in your repository.
indent-size: 2
line-ending-type: crlf
include-document-start: false
keep-line-breaks: false
disallow-anchors: true

// If the default commit message is too generic, or you want to create
// a custom commit message, for example, from the output of a previous
// workflow step, you can overwrite the commit message to any string.
# If the default commit message is too generic, or you want to create
# a custom commit message, for example, from the output of a previous
# workflow step, you can overwrite the commit message to any string.
commit-message: Reformat .yml files with yamlfmt

// When the formatting changes are made, they are committed by the bot
// account for GitHub Actions, and whoever pushed the unformatted file
// is listed as a co-author. To attribute the commit to a real person,
// or if you want to sign the commit, you can specify the username and
// email the same way you would to `git config user.name <USERNAME>`.
# When the formatting changes are made, they are committed by the bot
# account for GitHub Actions, and whoever pushed the unformatted file
# is listed as a co-author. To attribute the commit to a real person,
# or if you want to sign the commit, you can specify the username and
# email the same way you would to `git config user.name <USERNAME>`.
commit-user-name: <YOUR_GITHUB_USERNAME>
commit-user-email: <YOUR_GITHUB_EMAIL

// Not to be confused with signing a commit with the GPG key provided,
// a true boolean value for `signoff-on-commit` will add the `-s` flag
// to the commit command. This appends the `Signed-off-by` trailler to
// the commit message, certifying the commit.
//
// See also: http://developercertificate.org
# Not to be confused with signing a commit with the GPG key provided,
# a true boolean value for `signoff-on-commit` will add the `-s` flag
# to the commit command. This appends the `Signed-off-by` trailler to
# the commit message, certifying the commit.
#
# See also: http://developercertificate.org
signoff-on-commit: yes

// By default, the commits are not signed, which may make them show as
// unverified if any of the co-authors have vigilant mode turned on in
// their GitHub account settings. You can enable signed commits with a
// GPG private key stored in a secret, just be sure that the email set
// in the GPG key matches the email you set in `commit-user-email`!
# By default, the commits are not signed, which may make them show as
# unverified if any of the co-authors have vigilant mode turned on in
# their GitHub account settings. You can enable signed commits with a
# GPG private key stored in a secret, just be sure that the email set
# in the GPG key matches the email you set in `commit-user-email`!
signing-private-key: ${{ secrets.<YOUR_GPG_SIGNING_KEY> }}
signing-passphrase: ${{ secrets.<YOUR_GPG_PASSWORD> }}
```

0 comments on commit 02f44be

Please sign in to comment.