Merge remote-tracking branch 'origin/main' into jdb/2024-11-vale-rele…

…ases

Signed-off-by: Jack Baldry <[email protected]>

.github/workflows/add-to-docs-project.yml

@@ -7,7 +7,7 @@ on:
 
 jobs:
   main:
-    if:  ${{ github.repository == 'grafana/writers-toolkit' }}
+    if: ${{ github.repository == 'grafana/writers-toolkit' }}
     permissions:
       contents: read
       id-token: write

.github/workflows/backport.yml

@@ -7,7 +7,7 @@ on:
 
 jobs:
   main:
-    if:  ${{ github.repository == 'grafana/writers-toolkit' }}
+    if: ${{ github.repository == 'grafana/writers-toolkit' }}
     permissions:
       contents: read
       id-token: write

.github/workflows/dictionaries.yml

@@ -9,7 +9,7 @@ on:
         type: boolean
 jobs:
   main:
-    if:  ${{ github.repository == 'grafana/writers-toolkit' }}
+    if: ${{ github.repository == 'grafana/writers-toolkit' }}
     container:
       image: bitnami/jsonnet@sha256:3d8b084da1b74f5d38bc35e1ebf02f4a57c0410ec59d4edbc25dd2fec5f5541c
     runs-on: ubuntu-latest

.github/workflows/image.yml

@@ -11,7 +11,7 @@ permissions:
 
 jobs:
   build:
-    if:  ${{ github.repository == 'grafana/writers-toolkit' }}
+    if: ${{ github.repository == 'grafana/writers-toolkit' }}
     runs-on: ubuntu-latest
 
     steps:

.github/workflows/prettier.yml

@@ -9,10 +9,10 @@ on:
         type: boolean
 jobs:
   prettier:
-    if:  ${{ github.repository == 'grafana/writers-toolkit' }}
+    if: ${{ github.repository == 'grafana/writers-toolkit' }}
     runs-on: ubuntu-latest
     steps:
-      - uses: ./prettier
+      - uses: grafana/writers-toolkit/prettier@main
         with:
           branch: ${{ env.GITHUB_REF }}
           trace: ${{ inputs.trace }}

.github/workflows/test-publish-technical-documentation-release.yml

@@ -0,0 +1,35 @@
+# To use this workflow to test the publish-technical-documentation-release action:
+#   1. Create a branch `test/publish-technical-documentation/v<MAJOR>.<MINOR>.x`.
+#   2. Iterate on the workflow or action.
+#   3a. To test push events, push the branch.
+#   3b. To test tag events, tag the branch with `test/publish-technical-documentation/v<MAJOR>.<MINOR>.<PATCH>`.
+#   4. Check the workflow output in https://github.com/grafana/writers-toolkit/actions.
+
+name: test-publish-technical-documentation-release
+
+on:
+  push:
+    branches:
+      - test/publish-technical-documentation-release/v[0-9]+.[0-9]+.x
+    tags:
+      - test/publish-technical-documentation-release/v[0-9]+.[0-9]+.[0-9]+
+  workflow_dispatch:
+jobs:
+  sync:
+    if: github.repository == 'grafana/writers-toolkit'
+    permissions:
+      contents: read
+      id-token: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: ./publish-technical-documentation-release
+        with:
+          release_tag_regexp: "^test/publish-technical-documentation-release/v(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)$"
+          release_branch_regexp: "^test/publish-technical-documentation-release/v(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)\\.x$"
+          release_branch_with_patch_regexp: "^test/publish-technical-documentation-release/v(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)$"
+          website_branch: test/publish-technical-documentation-release
+          website_directory: content/docs/publish-technical-documetation-release
+          version_suffix: ""

.github/workflows/validate-documentation.yml

@@ -5,7 +5,7 @@ on:
   workflow_dispatch:
 jobs:
   doc-validator:
-    if:  ${{ github.repository == 'grafana/writers-toolkit' }}
+    if: ${{ github.repository == 'grafana/writers-toolkit' }}
     runs-on: ubuntu-latest
     container:
       image: grafana/doc-validator:v4.0.0
@@ -27,7 +27,7 @@ jobs:
         env:
           REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
   prettier:
-    if:  ${{ github.repository == 'grafana/writers-toolkit' }}
+    if: ${{ github.repository == 'grafana/writers-toolkit' }}
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -59,7 +59,7 @@ jobs:
         env:
           REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
   test:
-    if:  ${{ github.repository == 'grafana/writers-toolkit' }}
+    if: ${{ github.repository == 'grafana/writers-toolkit' }}
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -91,7 +91,7 @@ jobs:
           REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
   report-readability:
-    if:  ${{ github.repository == 'grafana/writers-toolkit' }}
+    if: ${{ github.repository == 'grafana/writers-toolkit' }}
     name: Report readability
     runs-on: ubuntu-latest
     steps:

RELEASE.md

@@ -10,6 +10,7 @@ The following directories contain GitHub Actions actions:
 - [`prettier`](./prettier/)
 - [`publish-technical-documentation`](./publish-technical-documentation/)
 - [`publish-technical-documentation-release`](./publish-technical-documentation-release/)
+- [`update-make-docs`](./update-make-docs/)
 
 You release each action by creating or updating Git tags.
 The Git tag begins with the action directory, then a slash (`/`), and then the tag version.

add-to-docs-project/index.mts

@@ -10,7 +10,7 @@ const PROJECT_ID = "PVT_kwDOAG3Mbc027w";
 const ISSUES_QUERY = fs.readFileSync("issues.graphql", "utf8");
 const ADD_TO_PROJECT_MUTATION = fs.readFileSync(
   "add-to-project.graphql",
-  "utf8"
+  "utf8",
 );
 
 async function addIssuesToProject(): Promise<Array<string>> {
@@ -26,14 +26,14 @@ async function addIssuesToProject(): Promise<Array<string>> {
 
     for (const issue of issues) {
       console.log(
-        `Adding issue ${issue.title} (${issue.url}) to the Docs project.`
+        `Adding issue ${issue.title} (${issue.url}) to the Docs project.`,
       );
       added.push(
         // https://api.slack.com/reference/surfaces/formatting#escaping
         `${issue.url}|${issue.title}`
           .replaceAll("&", "&amp;")
           .replaceAll("<", "&lt;")
-          .replaceAll(">", "&gt;")
+          .replaceAll(">", "&gt;"),
       );
 
       await octokit.graphql(ADD_TO_PROJECT_MUTATION, {
@@ -52,5 +52,5 @@ async function addIssuesToProject(): Promise<Array<string>> {
 const added = await addIssuesToProject();
 core.setOutput(
   "added",
-  added.map((issue) => `- <${issue}>`.replaceAll('"', '\\"')).join("\\n")
+  added.map((issue) => `- <${issue}>`.replaceAll('"', '\\"')).join("\\n"),
 );

add-to-docs-project/tsconfig.json

@@ -11,7 +11,7 @@
     // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
 
     /* Language and Environment */
-    "target": "es2022",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    "target": "es2022" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
     // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
     // "jsx": "preserve",                                /* Specify what JSX code is generated. */
     // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
@@ -25,9 +25,9 @@
     // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
 
     /* Modules */
-    "module": "nodenext",                                /* Specify what module code is generated. */
+    "module": "nodenext" /* Specify what module code is generated. */,
     // "rootDir": "./",                                  /* Specify the root folder within your source files. */
-    "moduleResolution": "nodenext",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    "moduleResolution": "nodenext" /* Specify how TypeScript looks up a file from a given module specifier. */,
     // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
     // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
     // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
@@ -76,12 +76,12 @@
     // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
     // "isolatedDeclarations": true,                     /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
     // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
-    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
     // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
-    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
 
     /* Type Checking */
-    "strict": true,                                      /* Enable all strict type-checking options. */
+    "strict": true /* Enable all strict type-checking options. */,
     // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
     // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
     // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
@@ -103,6 +103,6 @@
 
     /* Completeness */
     // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
-    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
   }
 }

docs/make-docs

@@ -6,22 +6,28 @@
 # [Semantic versioning](https://semver.org/) is used to help the reader identify the significance of changes.
 # Changes are relevant to this script and the support docs.mk GNU Make interface.
 #
-# ## 8.2.0 (2024-11-22)
+# ## 8.3.0 (2024-12-27)
 #
 # ### Added
 #
 # - Debug output of the final command when DEBUG=true.
 #
 #   Useful to inspect if the script is correctly constructing the final command.
 #
+# ## 8.2.0 (2024-12-22)
+#
+# ### Removed
+#
+# - Special cases for Oracle and Datadog plugins now that they exist in the plugins monorepo.
+#
 # ## 8.1.0 (2024-08-22)
 #
 # ### Added
 #
 # - Additional website mounts for projects that use the website repository.
 #
 #   Mounts are required for `make docs` to work in the website repository or with the website project.
-#   The Makefile is also mounted for convenient development of the procedure that repository.
+#   The Makefile is also mounted for convenient development of the procedure in that repository.
 #
 # ## 8.0.1 (2024-07-01)
 #
@@ -363,8 +369,6 @@ SOURCES_grafana_cloud_frontend_observability_faro_web_sdk='faro-web-sdk'
 SOURCES_helm_charts_mimir_distributed='mimir'
 SOURCES_helm_charts_tempo_distributed='tempo'
 SOURCES_opentelemetry='opentelemetry-docs'
-SOURCES_plugins_grafana_datadog_datasource='datadog-datasource'
-SOURCES_plugins_grafana_oracle_datasource='oracle-datasource'
 SOURCES_resources='website'
 
 VERSIONS_as_code='UNVERSIONED'
@@ -375,8 +379,6 @@ VERSIONS_grafana_cloud_k6='UNVERSIONED'
 VERSIONS_grafana_cloud_data_configuration_integrations='UNVERSIONED'
 VERSIONS_grafana_cloud_frontend_observability_faro_web_sdk='UNVERSIONED'
 VERSIONS_opentelemetry='UNVERSIONED'
-VERSIONS_plugins_grafana_datadog_datasource='latest'
-VERSIONS_plugins_grafana_oracle_datasource='latest'
 VERSIONS_resources='UNVERSIONED'
 VERSIONS_technical_documentation='UNVERSIONED'
 VERSIONS_website='UNVERSIONED'
@@ -386,8 +388,6 @@ PATHS_grafana_cloud='content/docs/grafana-cloud'
 PATHS_helm_charts_mimir_distributed='docs/sources/helm-charts/mimir-distributed'
 PATHS_helm_charts_tempo_distributed='docs/sources/helm-charts/tempo-distributed'
 PATHS_mimir='docs/sources/mimir'
-PATHS_plugins_grafana_datadog_datasource='docs/sources'
-PATHS_plugins_grafana_oracle_datasource='docs/sources'
 PATHS_resources='content'
 PATHS_tempo='docs/sources/tempo'
 PATHS_website='content'