From d976b1c65adca5c6b043c4141b2836c7ef08a856 Mon Sep 17 00:00:00 2001
From: Shuroii <shuroii@noreply.code.forgejo.org>
Date: Fri, 15 Aug 2025 19:32:45 +0000
Subject: [PATCH] docs: clarify actions_cache_url_option (#866)

The other setting that asks you for a URL as input
does so while specifically stating it should have a
trailing slash. This commit adds similar
clarification to the other setting.

<!--start release-notes-assistant-->
<!--URL:https://code.forgejo.org/forgejo/runner-->
- other
  - [PR](https://code.forgejo.org/forgejo/runner/pulls/866): <!--number 866 --><!--line 0 --><!--description ZG9jczogQ2xhcmlmeSBhY3Rpb25zX2NhY2hlX3VybF9vcHRpb24gW3NraXAgY2FzY2FkZV0=-->docs: Clarify actions_cache_url_option [skip cascade]<!--description-->
<!--end release-notes-assistant-->

Co-authored-by: Shuroii <shuroii@local.local>
Reviewed-on: https://code.forgejo.org/forgejo/runner/pulls/866
Reviewed-by: earl-warren <earl-warren@noreply.code.forgejo.org>
Co-authored-by: Shuroii <shuroii@noreply.code.forgejo.org>
Co-committed-by: Shuroii <shuroii@noreply.code.forgejo.org>
---
 internal/pkg/config/config.example.yaml | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/internal/pkg/config/config.example.yaml b/internal/pkg/config/config.example.yaml
index a3131b0b..ec12a8a1 100644
--- a/internal/pkg/config/config.example.yaml
+++ b/internal/pkg/config/config.example.yaml
@@ -140,10 +140,10 @@ cache:
   #
   proxy_port: 0
   #
-  # Overrides the ACTIONS_CACHE_URL passed to workflow
-  # containers. This should only be used if the runner host is not
-  # reachable from the workflow containers, and requires further
-  # setup.
+  # Overrides the ACTIONS_CACHE_URL variable passed to workflow
+  # containers. The URL should generally not end with "/". This should only
+  # be used if the runner host is not reachable from the workflow containers,
+  # and requires further setup.
   #
   actions_cache_url_override: ""