Skip to content

Commit eb38bf7

Browse files
Fix linting errors
Signed-off-by: faizanahmad055 <faizan.ahmad55@outlook.com>
1 parent 4b90335 commit eb38bf7

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ This instructs Reloader to skip all reload logic for that resource across all wo
171171
172172
### 4. ⚙️ Workload-Specific Rollout Strategy (Argo Rollouts Only)
173173
174-
Note: This is only applicable when using [Argo Rollouts](https://argoproj.github.io/argo-rollouts/). It is ignored for standard Kubernetes Deployments, StatefulSets, or DaemonSets. To use this feature, Argo Rollouts support must be enabled in Reloader (for example via --is-argo-rollouts=true).
174+
Note: This is only applicable when using [Argo Rollouts](https://argoproj.github.io/argo-rollouts/). It is ignored for standard Kubernetes `Deployments`, `StatefulSets`, or `DaemonSets`. To use this feature, Argo Rollouts support must be enabled in Reloader (for example via --is-argo-rollouts=true).
175175

176176
By default, Reloader triggers the Argo Rollout controller to perform a standard rollout by updating the pod template. This works well in most cases, however, because this modifies the workload spec, GitOps tools like ArgoCD will detect this as "Configuration Drift" and mark your application as OutOfSync.
177177

@@ -191,8 +191,8 @@ metadata:
191191
✅ Use `restart` if:
192192

193193
1. You're using GitOps and want to avoid drift
194-
2. You want a quick restart without changing the workload spec
195-
3. Your platform restricts metadata changes
194+
1. You want a quick restart without changing the workload spec
195+
1. Your platform restricts metadata changes
196196

197197
This setting affects Argo Rollouts behavior, not Argo CD sync settings.
198198

@@ -289,13 +289,13 @@ spec:
289289
secretKey: "password"
290290
```
291291

292-
***Important***: Reloader tracks changes to individual secrets (identified by secretKey). If your SecretProviderClass doesn't specify secretKey for each object, Reloader may not detect updates correctly.
292+
***Important***: Reloader tracks changes to individual secrets (identified by `secretKey`). If your SecretProviderClass doesn't specify `secretKey` for each object, Reloader may not detect updates correctly.
293293

294294
#### Notes & Limitations
295295

296296
Reloader reacts to CSI status changes, not direct updates to external secret stores
297297
Secret rotation must be enabled in the CSI driver for updates to be detected
298-
CSI limitations (such as subPath mounts) still apply and may require pod restarts
298+
CSI limitations (such as `subPath` mounts) still apply and may require pod restarts
299299
If secrets are synced to Kubernetes Secret objects, standard Reloader behavior applies and CSI support may not be required
300300

301301
## 🚀 Installation
@@ -489,7 +489,7 @@ PRs are welcome. In general, we follow the "fork-and-pull" Git workflow:
489489

490490
## Release Processes
491491

492-
_Repository GitHub releases_: As requested by the community in [issue 685](https://github.com/stakater/Reloader/issues/685), Reloader is now based on a manual release process. Releases are no longer done on every merged PR to the main branch, but manually on request.
492+
*Repository GitHub releases*: As requested by the community in [issue 685](https://github.com/stakater/Reloader/issues/685), Reloader is now based on a manual release process. Releases are no longer done on every merged PR to the main branch, but manually on request.
493493

494494
To make a GitHub release:
495495

@@ -502,7 +502,7 @@ To make a GitHub release:
502502
1. Code owners create another branch from `master` and bump the helm chart version as well as Reloader image version.
503503
- Code owners create a PR with `release/helm-chart` label, example: [PR-846](https://github.com/stakater/Reloader/pull/846)
504504

505-
_Repository git tagging_: Push to the main branch will create a merge-image and merge-tag named `merge-${{ github.event.number }}`, for example `merge-800` when pull request number 800 is merged.
505+
*Repository git tagging*: Push to the main branch will create a merge-image and merge-tag named `merge-${{ github.event.number }}`, for example `merge-800` when pull request number 800 is merged.
506506

507507
## Changelog
508508

0 commit comments

Comments
 (0)