Skip to content

Commit 2d255d0

Browse files
olblakolblak
authored
feat: announce deprecations (#2892)
* feat: announce deprecations Signed-off-by: Olblak <me@olblak.com> * init AGENTS.md Signed-off-by: Olblak <me@olblak.com> * remove matomo integration Signed-off-by: Olblak <me@olblak.com> * docs: announce github-action branch deprecation Signed-off-by: Olblak <me@olblak.com> * fix: cleanup updatecli gha workfow Signed-off-by: Olblak <me@olblak.com> --------- Signed-off-by: Olblak <me@olblak.com>
1 parent a377c7b commit 2d255d0

14 files changed

Lines changed: 207 additions & 32 deletions

File tree

‎.github/workflows/updatecli.yaml‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,23 @@ on:
66
schedule:
77
# Run at 12:00 every Saterday every 14 days
88
- cron: "0 12 */14 * *"
9+
10+
permissions: {}
11+
912
jobs:
1013
updatecli:
1114
runs-on: ubuntu-latest
1215
steps:
1316
- name: "Checkout"
1417
uses: "actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd" # v6.0.2
18+
with:
19+
persistent-credentials: false
20+
1521
- name: "Setup updatecli"
1622
uses: "updatecli/updatecli-action@3e2cbfd2d4bec97ce3ec7155da54ddf599893026" # v3.1.0
1723
with:
18-
version: "v0.115.0"
24+
version: "v0.116.0"
25+
1926
- name: "Run updatecli"
2027
run: updatecli compose apply --clean-git-branches=true --experimental
2128
env:

‎.github/workflows/updatecli_release.yaml‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ on:
99
repository_dispatch:
1010
types:
1111
- "updatecli-release"
12+
1213
permissions: {}
14+
1315
jobs:
1416
updatecli:
1517
runs-on: ubuntu-latest
@@ -19,14 +21,19 @@ jobs:
1921
steps:
2022
- name: "Checkout"
2123
uses: "actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd" # v6.0.2
24+
with:
25+
persist-credentials: false
26+
2227
- name: "Install Updatecli"
2328
uses: "updatecli/updatecli-action@3e2cbfd2d4bec97ce3ec7155da54ddf599893026" # v3.1.0
2429
with:
25-
version: "v0.115.0"
30+
version: "v0.116.0"
31+
2632
# releasepost is required by the Updatecli
2733
# * policy ghcr.io/updatecli/policies/releasepost/releasepost
2834
- name: "Install Releasepost"
2935
uses: "updatecli/releasepost-action@864390bddae97db06ee881ab4a08d159b4464643" # v0.5.0
36+
3037
- name: "Run updatecli only on release pipelines"
3138
run: updatecli compose apply --clean-git-branches=true --labels="release:updatecli" --experimental
3239
env:
@@ -36,6 +43,7 @@ jobs:
3643
UPDATECLI_UDASH_API_URL: ${{ secrets.UPDATECLI_UDASH_API_URL }}
3744
UPDATECLI_UDASH_ACCESS_TOKEN: ${{ secrets.UPDATECLI_UDASH_ACCESS_TOKEN }}
3845
UPDATECLI_UDASH_URL: ${{ secrets.UPDATECLI_UDASH_URL }}
46+
3947
- name: "Run updatecli"
4048
run: "updatecli compose apply --file updatecli-compose-release.yaml --experimental"
4149
env:

‎.github/workflows/updatecli_test.yaml‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,24 @@
11
name: Updatecli Test
22
on:
33
pull_request:
4+
45
permissions:
56
contents: read
7+
68
jobs:
79
updatecli:
810
runs-on: ubuntu-latest
911
steps:
1012
- name: "Checkout"
1113
uses: "actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd" # v6.0.2
14+
with:
15+
persist-credentials: false
16+
1217
- name: "Setup updatecli"
1318
uses: "updatecli/updatecli-action@3e2cbfd2d4bec97ce3ec7155da54ddf599893026" # v3.1.0
1419
with:
15-
version: "v0.115.0"
20+
version: "v0.116.0"
21+
1622
- name: "Test updatecli in dry-run mode"
1723
run: "updatecli compose diff --experimental"
1824
env:

‎.github/workflows/updatecli_update.yaml‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,23 @@ on:
55
push:
66
branches:
77
- master
8+
9+
permissions: {}
10+
811
jobs:
912
updatecli:
1013
runs-on: ubuntu-latest
1114
steps:
1215
- name: "Checkout"
1316
uses: "actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd" # v6.0.2
17+
with:
18+
persist-credentials: false
19+
1420
- name: "Setup updatecli"
1521
uses: "updatecli/updatecli-action@3e2cbfd2d4bec97ce3ec7155da54ddf599893026" # v3.1.0
1622
with:
17-
version: "v0.115.0"
23+
version: "v0.116.0"
24+
1825
- name: "Run updatecli only on monitored pipelines"
1926
run: updatecli compose apply --clean-git-branches=true --labels="monitor:active" --experimental
2027
env:
@@ -24,6 +31,7 @@ jobs:
2431
UPDATECLI_UDASH_API_URL: ${{ secrets.UPDATECLI_UDASH_API_URL }}
2532
UPDATECLI_UDASH_ACCESS_TOKEN: ${{ secrets.UPDATECLI_UDASH_ACCESS_TOKEN }}
2633
UPDATECLI_UDASH_URL: ${{ secrets.UPDATECLI_UDASH_URL }}
34+
2735
- name: "Run updatecli only on existing pipelines"
2836
run: updatecli compose apply --clean-git-branches=true --existing-only=true --experimental
2937
env:

‎AGENTS.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# AGENTS.md
2+
3+
## Repository overview
4+
5+
This repository contains the **Updatecli website**. It is a **Hugo** site using the
6+
**Doks** theme and is deployed on **Netlify**.
7+
8+
- Local development runs through `npm run start`
9+
- Production builds run through `npm run build`
10+
- Netlify publishes the generated `public/` directory
11+
12+
## Key paths
13+
14+
- `content/en/` - English site content
15+
- `content/en/docs/` - product documentation pages
16+
- `content/en/blog/<year>/` - blog posts
17+
- `assets/js/` - custom JavaScript bundled into the site
18+
- `assets/scss/` - SCSS overrides and site styling
19+
- `layouts/` - Hugo layout overrides
20+
- `config/_default/` - shared Hugo configuration
21+
- `config/production/`, `config/next/` - environment-specific Hugo config
22+
- `functions/` - Netlify functions
23+
- `static/` - static assets copied as-is at build time
24+
25+
## Common commands
26+
27+
1. Install dependencies: `npm install`
28+
2. Start local dev server: `npm run start`
29+
3. Build the site: `npm run build`
30+
4. Run all lint checks: `npm run lint`
31+
5. Run repository tests: `npm test`
32+
6. Lint only Markdown: `npm run lint:markdown`
33+
7. Regenerate command docs: `npm run docs`
34+
35+
## Content conventions
36+
37+
- Content files use Hugo front matter at the top of each document.
38+
- Documentation and blog content primarily live under `content/en/`.
39+
- Blog posts are organized by year under `content/en/blog/`.
40+
- The repo includes Markdown content and may also include AsciiDoc content.
41+
- Keep root Markdown files lint-friendly because `*.md` is covered by the
42+
markdown lint command.
43+
44+
## Frontend conventions
45+
46+
- JavaScript in `assets/js/`, `config/`, and `functions/` is linted with ESLint.
47+
- SCSS changes should follow the structure already used in `assets/scss/common/`,
48+
`assets/scss/components/`, and `assets/scss/layouts/`.
49+
- Site-specific style overrides belong in the existing custom SCSS files when
50+
appropriate instead of introducing parallel styling patterns.
51+
52+
## Configuration notes
53+
54+
- Hugo configuration is split across multiple TOML files under `config/_default/`.
55+
- Language configuration currently points English content to `content/en`.
56+
- The site enables Git info, Netlify redirects/headers outputs, and Hugo image
57+
processing through existing config.
58+
- Netlify development proxies the Hugo server on port `1313` through port `8888`.
59+
60+
## When making changes
61+
62+
- Prefer small, targeted edits that match existing Hugo, Doks, and content
63+
patterns.
64+
- Update the relevant content, layout, assets, and config together when a change
65+
spans multiple site surfaces.
66+
- Run the narrowest relevant command first, then broader validation as needed:
67+
Markdown lint for docs-only changes, full lint for frontend/config changes,
68+
and a Hugo build for rendering-sensitive changes.
69+
- If updating CLI command reference pages, check whether `npm run docs` should be
70+
used instead of editing generated command docs manually.

‎assets/code_example/docs/core/action/updatecli.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ actions:
77
title: 'deps: bump golangci-lint to {{ source "golangci-lint" }}'
88
kind: github/pullrequest
99
spec:
10-
automerge: true
10+
merge:
11+
strategy: auto
1112
labels:
1213
- chore
1314
- dependencies
@@ -55,4 +56,3 @@ targets:
5556
scmid: default
5657
sourceid: golangci-lint
5758
version: v0.68.0
58-

‎assets/code_example/docs/guides/helm-chart/updatecli.yaml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,11 @@ scms:
5757

5858
actions:
5959
default:
60-
kind: "github"
60+
kind: "github/pullrequest"
6161
scmid: "helm-charts"
6262
spec:
63-
automerge: true
63+
merge:
64+
strategy: auto
6465
labels:
6566
- "dependencies"
6667
- "jenkins-wiki-exporter"

‎assets/code_example/docs/guides/npm/updatecli.d/manifest.yaml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ actions:
9090
spec:
9191
labels:
9292
- dependencies
93-
automerge: true
93+
merge:
94+
strategy: auto
9495
usetitleforautomerge: true
9596
mergemethod: squash

‎assets/code_example/docs/plugins/actions/github_pullrequest/updatecli.yaml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ actions:
1818
kind: "github/pullrequest"
1919
scmid: "website"
2020
spec:
21-
automerge: true
21+
merge:
22+
strategy: auto
2223
description: "Prepend description"
2324
draft: false
2425
labels:

‎assets/code_example/docs/plugins/resources/github/release/updatecli.d/updatecli.yaml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ actions:
7474
scmid: default
7575
title: 'Bump Helm version to {{ source "helm" }}'
7676
spec:
77-
automerge: true
77+
merge:
78+
strategy: auto
7879
labels:
79-
- "helm"
80+
- "helm"

0 commit comments

Comments
 (0)