Skip to content

Commit

Permalink
Fixup GitHub actions error messages (#4037)
Browse files Browse the repository at this point in the history
* Update GitHub actions/checkout to v3

Currently when the linter runs it produces this warning

Node.js 12 actions are deprecated. Please update the following actions to use Node.js 16: actions/checkout@v2. For more information see: https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/.

This commit updates the GitHub action to use the actions/checkout action that uses Node.js 16

Signed-off-by: Gene Wood <[email protected]>

* Update markdownlint-cli2-action to version 5

Currently the lint GitHub action produces these warnings

Node.js 12 actions are deprecated. Please update the following actions to use Node.js 16: actions/checkout@v2, carlosperate/[email protected], DavidAnson/markdownlint-cli2-action@v4. For more information see: https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/.

This is resolved for markdownlint-cli2-action by updating to v5.0.0

https://github.com/DavidAnson/markdownlint-cli2-action/releases/tag/v5.0.0

This commit updates the action to use that new version

Signed-off-by: Gene Wood <[email protected]>

* Update download-file-action GitHub Action to v1.1.2

Currently the lint GitHub action produces these warnings

Node.js 12 actions are deprecated. Please update the following actions to use Node.js 16: actions/checkout@v2, carlosperate/[email protected], DavidAnson/markdownlint-cli2-action@v4. For more information see: https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/.

This is resolved in download-file-action at v1.1.2

https://github.com/carlosperate/download-file-action/releases/tag/v1.1.2

This commit updates the action to use this new version

Signed-off-by: Gene Wood <[email protected]>

* Fix lint issue with inconsistent strong style

This resolves the lint error

```
content/custom_resource_glossary.md:258:44 MD050/strong-style Strong style should be consistent [Expected: underscore; Actual: asterisk]
```

Signed-off-by: Gene Wood <[email protected]>

---------

Signed-off-by: Gene Wood <[email protected]>
Co-authored-by: Ian Maddaus <[email protected]>
  • Loading branch information
gene1wood and IanMadd authored Feb 2, 2023
1 parent 30b368e commit 227106c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
8 changes: 4 additions & 4 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
cspell-action:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
- uses: streetsidesoftware/[email protected]
with:
files: '**/*.md'
Expand All @@ -32,15 +32,15 @@ jobs:
markdownlint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
token: "${{ secrets.GITHUB_TOKEN }}"
- uses: carlosperate/download-file-action@v1.0.3
- uses: carlosperate/download-file-action@v1.1.2
id: download-mdl-config
with:
file-url: 'https://raw.githubusercontent.com/chef/chef-web-docs/main/.markdownlint.yaml'
file-name: 'markdownlint.yaml'
- uses: DavidAnson/markdownlint-cli2-action@v4
- uses: DavidAnson/markdownlint-cli2-action@v5
with:
globs: |
*.md
Expand Down
6 changes: 3 additions & 3 deletions content/custom_resource_glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ The following properties are identical to the properties in the execute resource
- `property :user`
- `property :sensitive`

Because both the custom properties and the **execute** properties are identical, this
Because both the custom properties and the __execute__ properties are identical, this
will result in an error message similar to:

```ruby
Expand Down Expand Up @@ -306,7 +306,7 @@ where:
- `user new_resource.user`
- `sensitive new_resource.sensitive`

Correctly use the properties of the **execute** resource and not the identically-named override properties of the custom resource.
Correctly use the properties of the __execute__ resource and not the identically-named override properties of the custom resource.

## property

Expand Down Expand Up @@ -566,7 +566,7 @@ reset_property(:password)

`coerce` is used to transform user input into a canonical form. The
value is passed in, and the transformed value returned as output. Lazy
values will **not** be passed to this method until after they are
values will __not__ be passed to this method until after they are
evaluated.

`coerce` is run in the context of the instance, which gives it access to
Expand Down

0 comments on commit 227106c

Please sign in to comment.