From 29063208a7c3e55ecc0cc7906d61c00aadab115d Mon Sep 17 00:00:00 2001 From: Shunsuke Suzuki Date: Sun, 30 Jun 2024 06:45:07 +0900 Subject: [PATCH 1/3] docs: fix broken links --- .github/ISSUE_TEMPLATE/v1-bug-report.md | 2 +- .github/ISSUE_TEMPLATE/v2-bug-report.md | 2 +- .github/ISSUE_TEMPLATE/v3-feature-request.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/v1-bug-report.md b/.github/ISSUE_TEMPLATE/v1-bug-report.md index cb9e8654fc..9b649e26ea 100644 --- a/.github/ISSUE_TEMPLATE/v1-bug-report.md +++ b/.github/ISSUE_TEMPLATE/v1-bug-report.md @@ -14,7 +14,7 @@ _**( Put the version of urfave/cli that you are using here )**_ ## Checklist - [ ] Are you running the latest v1 release? The list of releases is [here](https://github.com/urfave/cli/releases). -- [ ] Did you check the manual for your release? The v1 manual is [here](https://github.com/urfave/cli/blob/main/docs/v1/manual.md). +- [ ] Did you check the manual for your release? The v1 manual is [here](https://cli.urfave.org/v1/getting-started/). - [ ] Did you perform a search about this problem? Here's the [GitHub guide](https://help.github.com/en/github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests) about searching. ## Dependency Management diff --git a/.github/ISSUE_TEMPLATE/v2-bug-report.md b/.github/ISSUE_TEMPLATE/v2-bug-report.md index cce26671c4..4f9b1e62cb 100644 --- a/.github/ISSUE_TEMPLATE/v2-bug-report.md +++ b/.github/ISSUE_TEMPLATE/v2-bug-report.md @@ -14,7 +14,7 @@ _**( Put the version of urfave/cli that you are using here )**_ ## Checklist - [ ] Are you running the latest v2 release? The list of releases is [here](https://github.com/urfave/cli/releases). -- [ ] Did you check the manual for your release? The v2 manual is [here](https://github.com/urfave/cli/blob/main/docs/v2/manual.md) +- [ ] Did you check the manual for your release? The v2 manual is [here](https://cli.urfave.org/v2/getting-started/) - [ ] Did you perform a search about this problem? Here's the [GitHub guide](https://help.github.com/en/github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests) about searching. ## Dependency Management diff --git a/.github/ISSUE_TEMPLATE/v3-feature-request.md b/.github/ISSUE_TEMPLATE/v3-feature-request.md index f706c685ef..ab70d0e013 100644 --- a/.github/ISSUE_TEMPLATE/v3-feature-request.md +++ b/.github/ISSUE_TEMPLATE/v3-feature-request.md @@ -10,7 +10,7 @@ assignees: '' ## Checklist * [ ] Are you running the latest v3 release? The list of releases is [here](https://github.com/urfave/cli/releases). -* [ ] Did you check the manual for your release? The v3 manual is [here](https://github.com/urfave/cli/blob/main/docs/v3/manual.md). +* [ ] Did you check the manual for your release? The v3 manual is [here](https://github.com/urfave/cli/blob/main/docs/v3/index.md). * [ ] Did you perform a search about this feature? Here's the [GitHub guide](https://help.github.com/en/github/managing-your-work-on-github/using-search-to-filter-issues-and-pull-requests) about searching. ## What problem does this solve? From 6d8650f98d8d6eb3666cdea45db03c901ac3b7ee Mon Sep 17 00:00:00 2001 From: Shunsuke Suzuki Date: Sun, 30 Jun 2024 06:49:41 +0900 Subject: [PATCH 2/3] docs: fix broken links (cli.yml => test.yml) --- docs/CONTRIBUTING.md | 2 +- docs/index.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 349929f773..d46d4ac981 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -63,7 +63,7 @@ make Running the default `make` target (`all`) will ensure all of the critical steps are run to verify one's changes are harmonious in nature. The same steps are also run during the [continuous integration -phase](https://github.com/urfave/cli/blob/main/.github/workflows/cli.yml). +phase](https://github.com/urfave/cli/blob/main/.github/workflows/test.yml). In the event that the `v3diff` target exits non-zero, this is a signal that the public API surface area has changed. If the changes are acceptable, then manually running the diff --git a/docs/index.md b/docs/index.md index bf7f7d7bc3..3d1a051432 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,7 +4,7 @@ https://github.com/urfave/cli/blob/main/README.md --> # Welcome to urfave/cli -[![Run Tests](https://github.com/urfave/cli/actions/workflows/cli.yml/badge.svg)](https://github.com/urfave/cli/actions/workflows/cli.yml) +[![Run Tests](https://github.com/urfave/cli/actions/workflows/test.yml/badge.svg)](https://github.com/urfave/cli/actions/workflows/test.yml) [![Go Reference](https://pkg.go.dev/badge/github.com/urfave/cli/v3.svg)](https://pkg.go.dev/github.com/urfave/cli/v3) [![Go Report Card](https://goreportcard.com/badge/github.com/urfave/cli/v3)](https://goreportcard.com/report/github.com/urfave/cli/v3) [![codecov](https://codecov.io/gh/urfave/cli/branch/main/graph/badge.svg?token=t9YGWLh05g)](https://codecov.io/gh/urfave/cli) @@ -94,4 +94,4 @@ cli is tested against multiple versions of Go on Linux, and against the latest released version of Go on OS X and Windows. This project uses GitHub Actions for builds. To see our currently supported go versions and platforms, look at the [github workflow -configuration](https://github.com/urfave/cli/blob/main/.github/workflows/cli.yml). +configuration](https://github.com/urfave/cli/blob/main/.github/workflows/test.yml). From e4e92db6b57be87e9e5c7feac021f17fe6b8df6b Mon Sep 17 00:00:00 2001 From: Shunsuke Suzuki Date: Sun, 30 Jun 2024 06:56:50 +0900 Subject: [PATCH 3/3] docs: fix a broken link --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index d46d4ac981..c0054eb9a6 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -81,7 +81,7 @@ step. #### docs output The documentation in the `docs` directory is automatically built via `mkdocs` into a -static site and published when releases are pushed (see [RELEASING](./RELEASING/)). There +static site and published when releases are pushed (see [RELEASING](./RELEASING.md)). There is no strict requirement to build the documentation when developing locally, but the following `make` targets may be used if desired: