diff --git a/__tests__/setup-go.test.ts b/__tests__/setup-go.test.ts index 8cefcced0..3c0af1122 100644 --- a/__tests__/setup-go.test.ts +++ b/__tests__/setup-go.test.ts @@ -92,7 +92,7 @@ describe('setup-go', () => { getManifestSpy = jest.spyOn(tc, 'getManifestFromRepo'); getAllVersionsSpy = jest.spyOn(im, 'getManifest'); - // httm + // httpm httpmGetJsonSpy = jest.spyOn(httpm.HttpClient.prototype, 'getJson'); // io @@ -146,7 +146,7 @@ describe('setup-go', () => { expect(main.parseGoVersion(goVersionOutput)).toBe('1.16.6'); }); - it('can find 1.9.7 from manifest on osx', async () => { + it('can find 1.9.7 from manifest on macOS', async () => { os.platform = 'darwin'; os.arch = 'x64'; @@ -544,7 +544,7 @@ describe('setup-go', () => { expect(added).toBeFalsy(); }); - it('adds bin if dir not exists', async () => { + it('adds bin if dir does not exist', async () => { whichSpy.mockImplementation(async () => { return '/usr/local/go/bin/go'; }); @@ -756,7 +756,7 @@ describe('setup-go', () => { ); }); - it('fallback to dist if version is not found in manifest', async () => { + it('fall back to dist if version is not found in manifest', async () => { os.platform = 'linux'; os.arch = 'x64'; @@ -793,7 +793,7 @@ describe('setup-go', () => { expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`); }); - it('fallback to dist if manifest is not available', async () => { + it('fall back to dist if manifest is not available', async () => { os.platform = 'linux'; os.arch = 'x64'; diff --git a/action.yml b/action.yml index c5726e1bf..1e7432efd 100644 --- a/action.yml +++ b/action.yml @@ -1,5 +1,5 @@ name: 'Setup Go environment' -description: 'Setup a Go environment and add it to the PATH' +description: 'Set up a Go environment and add it to the PATH' author: 'GitHub' inputs: go-version: @@ -8,13 +8,13 @@ inputs: description: 'Path to the go.mod, go.work, .go-version, or .tool-versions file.' check-latest: description: 'Set this option to true if you want the action to always check for the latest available version that satisfies the version spec' - default: false + default: 'false' token: description: Used to pull Go distributions from go-versions. Since there's a default, this is typically not supplied by the user. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting. default: ${{ github.server_url == 'https://github.com' && github.token || '' }} cache: description: Used to specify whether caching is needed. Set to true, if you'd like to enable caching. - default: true + default: 'true' cache-dependency-path: description: 'Used to specify the path to a dependency file (e.g., go.mod, go.sum)' architecture: diff --git a/docs/contributors.md b/docs/contributors.md index 43412122e..96c5fa92c 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -27,7 +27,7 @@ Pull requests are the easiest way to contribute changes to git repos at GitHub. - Please check that no one else has already created a pull request with these changes - Use a "feature branch" for your changes. That separates the changes in the pull request from your other changes and makes it easy to edit/amend commits in the pull request - Make sure your changes are formatted correctly and consistently with the rest of the documentation -- Re-read what you wrote, and run a spellchecker on it to make sure you didn't miss anything +- Re-read what you wrote, and run a spell checker on it to make sure you didn't miss anything - If your pull request is connected to an open issue, please, leave a link to this issue in the `Related issue:` section - If you later need to add new commits to the pull request, you can simply commit the changes to the local branch and then push them. The pull request gets automatically updated @@ -62,7 +62,7 @@ Pull requests are the easiest way to contribute changes to git repos at GitHub. - To implement new features or fix bugs, you need to make changes to the `.ts` files, which are located in the `src` folder - To comply with the code style, **you need to run the `format` script** - To lint the code, **you need to run the `lint:fix` script** -- To transpile source code to `javascript` we use [NCC](https://github.com/vercel/ncc). **It is very important to run the `build` script after making changes**, otherwise your changes will not get into the final `javascript` build +- To transpile source code to `javascript` we use [NCC](https://github.com/vercel/ncc). **It is very important to run the `build` script after making changes**; otherwise, your changes will not get into the final `javascript` build - You can also start formatting, building code, and testing with a single `pre-checkin` command **Learn more about how to implement tests:**