Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Add custom configuration file path to args #767

Merged
merged 3 commits into from
Jun 8, 2023

Conversation

Aisuko
Copy link
Contributor

@Aisuko Aisuko commented Jun 8, 2023

Thanks for the excellent work, it is really helpful. And there is a useful example of custom configuration, it can reduce the users' confusion. It was mentioned at #26 So, please consider merging this PR.

Signed-off-by: Aisuko <urakiny@gmail.com>
@ldez ldez added the documentation Improvements or additions to documentation label Jun 8, 2023
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Aisuko and others added 2 commits June 9, 2023 00:32
Co-authored-by: Ludovic Fernandez <ldez@users.noreply.github.com>
Co-authored-by: Ludovic Fernandez <ldez@users.noreply.github.com>
Copy link
Member

@ldez ldez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you 👍

@ldez ldez enabled auto-merge (squash) June 8, 2023 14:34
@ldez ldez merged commit 8c13ec4 into golangci:master Jun 8, 2023
@Aisuko Aisuko deleted the feat/doc branch June 9, 2023 00:11
another-rex referenced this pull request in google/osv-scanner Jun 21, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [actions/checkout](https://github.com/actions/checkout) | action |
patch | `v3.5.2` -> `v3.5.3` |
| [docker/login-action](https://github.com/docker/login-action) |
action | digest | `f4ef78c` -> `465a078` |
|
[docker/setup-buildx-action](https://github.com/docker/setup-buildx-action)
| action | digest | `4b4e9c3` -> `ecf9528` |
|
[docker/setup-qemu-action](https://github.com/docker/setup-qemu-action)
| action | digest | `e81a89b` -> `2b82ce8` |
| [github/codeql-action](https://github.com/github/codeql-action) |
action | minor | `v2.3.6` -> `v2.20.0` |
|
[golangci/golangci-lint-action](https://github.com/golangci/golangci-lint-action)
| action | minor | `v3.5.0` -> `v3.6.0` |
|
[goreleaser/goreleaser-action](https://github.com/goreleaser/goreleaser-action)
| action | minor | `v4.2.0` -> `v4.3.0` |
|
[slsa-framework/slsa-github-generator](https://github.com/slsa-framework/slsa-github-generator)
| action | minor | `v1.6.0` -> `v1.7.0` |

---

### Release Notes

<details>
<summary>actions/checkout</summary>

###
[`v3.5.3`](https://github.com/actions/checkout/blob/HEAD/CHANGELOG.md#v353)

[Compare
Source](https://github.com/actions/checkout/compare/v3.5.2...v3.5.3)

- [Fix: Checkout fail in self-hosted runners when faulty submodule are
checked-in](https://github.com/actions/checkout/pull/1196)
- [Fix typos found by
codespell](https://github.com/actions/checkout/pull/1287)
- [Add support for sparse
checkouts](https://github.com/actions/checkout/pull/1369)

</details>

<details>
<summary>github/codeql-action</summary>

###
[`v2.20.0`](https://github.com/github/codeql-action/compare/v2.3.6...v2.20.0)

[Compare
Source](https://github.com/github/codeql-action/compare/v2.3.6...v2.20.0)

</details>

<details>
<summary>golangci/golangci-lint-action</summary>

###
[`v3.6.0`](https://github.com/golangci/golangci-lint-action/releases/tag/v3.6.0)

[Compare
Source](https://github.com/golangci/golangci-lint-action/compare/v3.5.0...v3.6.0)

#### What's Changed

- docs: fix example by [@&#8203;yuki0920](https://github.com/yuki0920)
in
[https://github.com/golangci/golangci-lint-action/pull/762](https://github.com/golangci/golangci-lint-action/pull/762)
- doc: Add custom configuration file path to args by
[@&#8203;Aisuko](https://github.com/Aisuko) in
[https://github.com/golangci/golangci-lint-action/pull/767](https://github.com/golangci/golangci-lint-action/pull/767)
- feat: add install-mode by [@&#8203;ldez](https://github.com/ldez) in
[https://github.com/golangci/golangci-lint-action/pull/768](https://github.com/golangci/golangci-lint-action/pull/768)
- feat: support out-format as args by
[@&#8203;jrehwaldt](https://github.com/jrehwaldt) in
[https://github.com/golangci/golangci-lint-action/pull/769](https://github.com/golangci/golangci-lint-action/pull/769)
- fix: out-format by [@&#8203;ldez](https://github.com/ldez) in
[https://github.com/golangci/golangci-lint-action/pull/770](https://github.com/golangci/golangci-lint-action/pull/770)

#### New Contributors

- [@&#8203;yuki0920](https://github.com/yuki0920) made their first
contribution in
[https://github.com/golangci/golangci-lint-action/pull/762](https://github.com/golangci/golangci-lint-action/pull/762)
- [@&#8203;Aisuko](https://github.com/Aisuko) made their first
contribution in
[https://github.com/golangci/golangci-lint-action/pull/767](https://github.com/golangci/golangci-lint-action/pull/767)
- [@&#8203;ldez](https://github.com/ldez) made their first
contribution in
[https://github.com/golangci/golangci-lint-action/pull/768](https://github.com/golangci/golangci-lint-action/pull/768)
- [@&#8203;jrehwaldt](https://github.com/jrehwaldt) made their first
contribution in
[https://github.com/golangci/golangci-lint-action/pull/769](https://github.com/golangci/golangci-lint-action/pull/769)

**Full Changelog**:
golangci/golangci-lint-action@v3.5.0...v3.6.0

</details>

<details>
<summary>goreleaser/goreleaser-action</summary>

###
[`v4.3.0`](https://github.com/goreleaser/goreleaser-action/releases/tag/v4.3.0)

[Compare
Source](https://github.com/goreleaser/goreleaser-action/compare/v4.2.0...v4.3.0)

#### What's Changed

- Update in command examples by
[@&#8203;arnaduga](https://github.com/arnaduga) in
[https://github.com/goreleaser/goreleaser-action/pull/393](https://github.com/goreleaser/goreleaser-action/pull/393)
- chore(deps): bump yargs from 17.6.2 to 17.7.0 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/goreleaser/goreleaser-action/pull/395](https://github.com/goreleaser/goreleaser-action/pull/395)
- Improve documentation for use of `GITHUB_TOKEN` by
[@&#8203;jamietanna](https://github.com/jamietanna) in
[https://github.com/goreleaser/goreleaser-action/pull/399](https://github.com/goreleaser/goreleaser-action/pull/399)
- chore(deps): bump actions/setup-go from 3 to 4 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/goreleaser/goreleaser-action/pull/403](https://github.com/goreleaser/goreleaser-action/pull/403)
- chore(deps): bump docker/bake-action from 2 to 3 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/goreleaser/goreleaser-action/pull/408](https://github.com/goreleaser/goreleaser-action/pull/408)
- chore(deps): bump semver from 7.3.8 to 7.5.0 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/goreleaser/goreleaser-action/pull/407](https://github.com/goreleaser/goreleaser-action/pull/407)
- Bump setup-go action version to v4 in README by
[@&#8203;kishaningithub](https://github.com/kishaningithub) in
[https://github.com/goreleaser/goreleaser-action/pull/411](https://github.com/goreleaser/goreleaser-action/pull/411)
- ci: split test and validate workflow by
[@&#8203;crazy-max](https://github.com/crazy-max) in
[https://github.com/goreleaser/goreleaser-action/pull/413](https://github.com/goreleaser/goreleaser-action/pull/413)
- chore: update yarn to 3.5.1 by
[@&#8203;crazy-max](https://github.com/crazy-max) in
[https://github.com/goreleaser/goreleaser-action/pull/412](https://github.com/goreleaser/goreleaser-action/pull/412)
- chore(deps): bump yargs from 17.7.1 to 17.7.2 by
[@&#8203;dependabot](https://github.com/dependabot) in
[https://github.com/goreleaser/goreleaser-action/pull/410](https://github.com/goreleaser/goreleaser-action/pull/410)
- feat: support nightly by
[@&#8203;caarlos0](https://github.com/caarlos0) in
[https://github.com/goreleaser/goreleaser-action/pull/419](https://github.com/goreleaser/goreleaser-action/pull/419)

#### New Contributors

- [@&#8203;arnaduga](https://github.com/arnaduga) made their first
contribution in
[https://github.com/goreleaser/goreleaser-action/pull/393](https://github.com/goreleaser/goreleaser-action/pull/393)
- [@&#8203;jamietanna](https://github.com/jamietanna) made their first
contribution in
[https://github.com/goreleaser/goreleaser-action/pull/399](https://github.com/goreleaser/goreleaser-action/pull/399)
- [@&#8203;kishaningithub](https://github.com/kishaningithub) made
their first contribution in
[https://github.com/goreleaser/goreleaser-action/pull/411](https://github.com/goreleaser/goreleaser-action/pull/411)

**Full Changelog**:
goreleaser/goreleaser-action@v4.2.0...v4.3.0

</details>

<details>
<summary>slsa-framework/slsa-github-generator</summary>

###
[`v1.7.0`](https://github.com/slsa-framework/slsa-github-generator/releases/tag/v1.7.0)

[Compare
Source](https://github.com/slsa-framework/slsa-github-generator/compare/v1.6.0...v1.7.0)

See the [CHANGELOG](./CHANGELOG.md) for details.

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "before 6am on monday" in timezone
Australia/Sydney, Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

👻 **Immortal**: This PR will be recreated if closed unmerged. Get
[config help](https://github.com/renovatebot/renovate/discussions) if
that's undesired.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/google/osv-scanner).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4xMTAuMCIsInVwZGF0ZWRJblZlciI6IjM1LjEzMS4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->
kodiakhq bot referenced this pull request in cloudquery/cloudquery Aug 1, 2023
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| booxmedialtd/ws-action-parse-semver | action | digest | `966a265` -> `7784200` |
| [docker.elastic.co/elasticsearch/elasticsearch](https://github.com/elastic/elasticsearch) | service | minor | `8.7.0` -> `8.9.0` |
| getmeili/meilisearch | service | minor | `v1.1.0` -> `v1.3.0` |
| [golangci/golangci-lint-action](https://github.com/golangci/golangci-lint-action) | action | minor | `v3.4.0` -> `v3.6.0` |
| mtlynch/firestore-emulator | service | digest | `327f3c8` -> `74dc4be` |
| peter-evans/create-or-update-comment | action | digest | `5f728c3` -> `716151b` |
| peter-evans/find-comment | action | digest | `ebedc73` -> `5cea877` |
| tinkerpop/gremlin-server | service | patch | `3.6.2` -> `3.6.4` |

---

### ⚠ Dependency Lookup Warnings ⚠

Warnings were logged while processing this repo. Please check the Dependency Dashboard for more information.

---

### Release Notes

<details>
<summary>elastic/elasticsearch (docker.elastic.co/elasticsearch/elasticsearch)</summary>

### [`v8.9.0`](https://github.com/elastic/elasticsearch/releases/tag/v8.9.0): Elasticsearch 8.9.0

[Compare Source](https://github.com/elastic/elasticsearch/compare/v8.8.2...v8.9.0)

Downloads: https://elastic.co/downloads/elasticsearch
Release notes: https://www.elastic.co/guide/en/elasticsearch/reference/8.9/release-notes-8.9.0.html

### [`v8.8.2`](https://github.com/elastic/elasticsearch/releases/tag/v8.8.2): Elasticsearch 8.8.2

[Compare Source](https://github.com/elastic/elasticsearch/compare/v8.8.1...v8.8.2)

Downloads: https://elastic.co/downloads/elasticsearch
Release notes: https://www.elastic.co/guide/en/elasticsearch/reference/8.8/release-notes-8.8.2.html

### [`v8.8.1`](https://github.com/elastic/elasticsearch/releases/tag/v8.8.1): Elasticsearch 8.8.1

[Compare Source](https://github.com/elastic/elasticsearch/compare/v8.8.0...v8.8.1)

Downloads: https://elastic.co/downloads/elasticsearch
Release notes: https://www.elastic.co/guide/en/elasticsearch/reference/8.8/release-notes-8.8.1.html

### [`v8.8.0`](https://github.com/elastic/elasticsearch/releases/tag/v8.8.0): Elasticsearch 8.8.0

[Compare Source](https://github.com/elastic/elasticsearch/compare/v8.7.1...v8.8.0)

Downloads: https://elastic.co/downloads/elasticsearch
Release notes: https://www.elastic.co/guide/en/elasticsearch/reference/8.8/release-notes-8.8.0.html

### [`v8.7.1`](https://github.com/elastic/elasticsearch/releases/tag/v8.7.1): Elasticsearch 8.7.1

[Compare Source](https://github.com/elastic/elasticsearch/compare/v8.7.0...v8.7.1)

Downloads: https://elastic.co/downloads/elasticsearch
Release notes: https://www.elastic.co/guide/en/elasticsearch/reference/8.7/release-notes-8.7.1.html

</details>

<details>
<summary>golangci/golangci-lint-action (golangci/golangci-lint-action)</summary>

### [`v3.6.0`](https://github.com/golangci/golangci-lint-action/releases/tag/v3.6.0)

[Compare Source](https://github.com/golangci/golangci-lint-action/compare/v3.5.0...v3.6.0)

#### What's Changed

-   docs: fix example by [@&#8203;yuki0920](https://github.com/yuki0920) in [https://github.com/golangci/golangci-lint-action/pull/762](https://github.com/golangci/golangci-lint-action/pull/762)
-   doc: Add custom configuration file path to args by [@&#8203;Aisuko](https://github.com/Aisuko) in [https://github.com/golangci/golangci-lint-action/pull/767](https://github.com/golangci/golangci-lint-action/pull/767)
-   feat: add install-mode by [@&#8203;ldez](https://github.com/ldez) in [https://github.com/golangci/golangci-lint-action/pull/768](https://github.com/golangci/golangci-lint-action/pull/768)
-   feat: support out-format as args by [@&#8203;jrehwaldt](https://github.com/jrehwaldt) in [https://github.com/golangci/golangci-lint-action/pull/769](https://github.com/golangci/golangci-lint-action/pull/769)
-   fix: out-format by [@&#8203;ldez](https://github.com/ldez) in [https://github.com/golangci/golangci-lint-action/pull/770](https://github.com/golangci/golangci-lint-action/pull/770)

#### New Contributors

-   [@&#8203;yuki0920](https://github.com/yuki0920) made their first contribution in [https://github.com/golangci/golangci-lint-action/pull/762](https://github.com/golangci/golangci-lint-action/pull/762)
-   [@&#8203;Aisuko](https://github.com/Aisuko) made their first contribution in [https://github.com/golangci/golangci-lint-action/pull/767](https://github.com/golangci/golangci-lint-action/pull/767)
-   [@&#8203;ldez](https://github.com/ldez) made their first contribution in [https://github.com/golangci/golangci-lint-action/pull/768](https://github.com/golangci/golangci-lint-action/pull/768)
-   [@&#8203;jrehwaldt](https://github.com/jrehwaldt) made their first contribution in [https://github.com/golangci/golangci-lint-action/pull/769](https://github.com/golangci/golangci-lint-action/pull/769)

**Full Changelog**: golangci/golangci-lint-action@v3.5.0...v3.6.0

### [`v3.5.0`](https://github.com/golangci/golangci-lint-action/releases/tag/v3.5.0)

[Compare Source](https://github.com/golangci/golangci-lint-action/compare/v3.4.0...v3.5.0)

#### What's Changed

-   doc: add quote around go version by [@&#8203;vaughany](https://github.com/vaughany) in [https://github.com/golangci/golangci-lint-action/pull/670](https://github.com/golangci/golangci-lint-action/pull/670)
-   docs/build: update to setup-go@v4 by [@&#8203;caarlos0](https://github.com/caarlos0) in [https://github.com/golangci/golangci-lint-action/pull/704](https://github.com/golangci/golangci-lint-action/pull/704)
-   fix invalid docs about cache key by [@&#8203;hori-ryota](https://github.com/hori-ryota) in [https://github.com/golangci/golangci-lint-action/pull/695](https://github.com/golangci/golangci-lint-action/pull/695)

#### New Contributors

-   [@&#8203;vaughany](https://github.com/vaughany) made their first contribution in [https://github.com/golangci/golangci-lint-action/pull/670](https://github.com/golangci/golangci-lint-action/pull/670)
-   [@&#8203;caarlos0](https://github.com/caarlos0) made their first contribution in [https://github.com/golangci/golangci-lint-action/pull/704](https://github.com/golangci/golangci-lint-action/pull/704)
-   [@&#8203;hori-ryota](https://github.com/hori-ryota) made their first contribution in [https://github.com/golangci/golangci-lint-action/pull/695](https://github.com/golangci/golangci-lint-action/pull/695)

**Full Changelog**: golangci/golangci-lint-action@v3.4.0...v3.5.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "before 4am on the first day of the month" (UTC), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://github.com/renovatebot/renovate/discussions) if that's undesired.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi4yNi4xIiwidXBkYXRlZEluVmVyIjoiMzYuMjYuMSIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants