ci: add check broken links workflow (#1536)

* ci: add check broken links workflow

* chore: update .lycheeignore

* chore: update .lycheeignore again

* ci: fix link checking by building docs site first to resolve local paths

* ci: update node version to 20 for docusaurus build

* chore: update workflow

Author: marcossevilla

.github/workflows/check_links.yaml

@@ -0,0 +1,27 @@
+name: check_links
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  schedule:
+    # Runs every Monday at 08:00 UTC
+    - cron: "0 8 * * 1"
+
+jobs:
+  check_links:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - name: Link Checker
+        id: lychee
+        uses: lycheeverse/lychee-action@v2
+        with:
+          fail: false

.lycheeignore

@@ -0,0 +1,20 @@
+# Lychee ignore patterns
+# See https://github.com/lycheeverse/lychee for documentation
+
+# Placeholder and test-fixture URLs (not real links)
+https://github.com/org/repo
+https://github.com/verygoodopensource/_very_good_analysis
+https://not-pub.dev
+
+# Partial URL used as a string template in source code
+https://github.com/verygoodopensource/very_good_cli/releases/tag/v
+
+# External sites that block automated requests
+https://www.cyberciti.biz
+
+# Fake file:// URIs in test fixtures (not real filesystem paths)
+^file://
+
+# Dart string interpolation placeholders in source code (e.g. $packageName)
+# These are not real URLs — lychee picks them up as literal link text
+\$\w+

CODE_OF_CONDUCT.md

@@ -73,4 +73,4 @@ available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.ht
 [homepage]: https://www.contributor-covenant.org
 
 For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faqs
+https://www.contributor-covenant.org/faq/

README.md

@@ -241,7 +241,7 @@ Run "very_good help <command>" for more information about a command.
 [logging_link]: https://api.flutter.dev/flutter/dart-developer/log.html
 [null_safety_link]: https://flutter.dev/docs/null-safety
 [pub_badge]: https://img.shields.io/pub/v/very_good_cli.svg
-[pub_link]: https://pub.dartlang.org/packages/very_good_cli
+[pub_link]: https://pub.dev/packages/very_good_cli
 [testing_link]: https://flutter.dev/docs/testing
 [very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
 [very_good_analysis_link]: https://pub.dev/packages/very_good_analysis

lib/src/command_runner.dart

@@ -160,7 +160,7 @@ Run ${lightCyan.wrap('very_good update')} to update''');
         '''
 
 Thank you for using Very Good Ventures open source tools!
-Don't forget to fill out this form to get information on future updates and releases here: ${lightBlue.wrap(link(uri: Uri.parse('https://verygood.ventures/dev/tools/cli/subscribe')))}''',
+Follow us on GitHub for updates on future releases: ${lightBlue.wrap(link(uri: Uri.parse('https://verygood.ventures/resources/open-source-packages/')))}''',
       ),
       print: _logger.info,
     );

site/docs/templates/flame_game.md

@@ -20,7 +20,7 @@ Read more about this game template [in our blog][blog].
 
 - **Audio** - Background music and sound effects within the game.
 
-- **VGV Project Architecture** - This project contains a similar architecture to other VGV projects (see our [core starter app](https://github.com/VeryGoodOpenSource/very_good_core/tree/main/src/my_app)).
+- **VGV Project Architecture** - This project contains a similar architecture to other VGV projects (see our [core starter app](https://github.com/VeryGoodOpenSource/very_good_templates/tree/main/very_good_core)).
 
 - **100% Test Coverage** — Each line is executed at least once by a test.
 

test/src/command_runner_test.dart

@@ -215,14 +215,12 @@ void main() {
               verifyInOrder([
                 () => logger.info('\nThank you for using Very Good '),
                 () => logger.info('Ventures open source '),
-                () => logger.info("tools!\nDon't forget to fill "),
-                () => logger.info('out this form to get '),
-                () => logger.info('information on future updates '),
-                () => logger.info('and releases here: '),
+                () => logger.info('tools!\nFollow us on GitHub for '),
+                () => logger.info('updates on future releases: '),
                 () => logger.info(
                   any(
                     that: contains(
-                      'https://verygood.ventures/dev/tools/cli/subscribe',
+                      'https://verygood.ventures/resources/open-source-packages/',
                     ),
                   ),
                 ),