ci: add chloggen and workflows for changelog generation

.chloggen/README.md

@@ -0,0 +1,33 @@
+### Changelog folder
+
+This repo uses `chloggen` to manage its changelog files. You can find the source code for the tool [here](https://github.com/open-telemetry/opentelemetry-go-build-tools/tree/main/chloggen).
+
+Here is a quick explanation of the `config.yaml` file for chloggen:
+
+```yaml
+# The directory that stores individual changelog entries.
+# Each entry is stored in a dedicated yaml file.
+# - 'chloggen new' will copy the 'template_yaml' to this directory as a new entry file.
+# - 'chloggen validate' will validate that all entry files are valid.
+# - 'chloggen update' will read and delete all entry files in this directory, and update 'changelog_md'.
+# Specify as relative path from root of repo.
+# (Optional) Default: .chloggen
+entries_dir: .chloggen
+
+# This file is used as the input for individual changelog entries.
+# Specify as relative path from root of repo.
+# (Optional) Default: .chloggen/TEMPLATE.yaml
+template_yaml: .chloggen/TEMPLATE.yaml
+
+summary_template: .chloggen/summary.tmpl
+
+# The CHANGELOG file or files to which 'chloggen update' will write new entries
+# (Optional) Default filename: CHANGELOG.md
+change_logs:
+  user: CHANGELOG.md
+
+# The default change_log or change_logs to which an entry should be added.
+# If 'change_logs' is specified in this file, and no value is specified for 'default_change_logs',
+# then 'change_logs' MUST be specified in every entry file.
+default_change_logs: [user]
+```

.chloggen/TEMPLATE.yaml

@@ -0,0 +1,18 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'feature', 'bug_fix', 'docs'. Inferred from conventional commit tag if PR created before `make chlog-new`.
+change_type:
+
+# Mandatory. One of: distributions, distributions/nrdot-collector, distributions/nrdot-collector-experimental, examples
+component:
+
+# Mandatory. Put the PR number here. Inferred from PR number if PR created before `make chlog-new`.
+issues: []
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note:
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:

.chloggen/config.yaml

@@ -0,0 +1,12 @@
+change_logs:
+    user: CHANGELOG.md
+default_change_logs:
+    - user
+entries_dir: .chloggen
+template_yaml: .chloggen/TEMPLATE.yaml
+summary_template: .chloggen/summary.tmpl
+components:
+    - distributions
+    - distributions/nrdot-collector
+    - distributions/nrdot-collector-experimental
+    - examples

.chloggen/summary.tmpl

@@ -0,0 +1,48 @@
+{{- define "entry" -}}
+- `{{ .Component }}`: {{ .Note }} (
+{{- range $i, $issue := .Issues }}
+{{- if $i }}, {{ end -}}
+#{{ $issue }}
+{{- end -}}
+)
+
+{{- if .SubText }}
+{{ .SubText | indent 2 }}
+{{- end }}
+{{- end }}
+## {{ .Version }}
+
+{{- if .Enhancements }}
+
+### Features
+
+{{- range $i, $change := .Enhancements }}
+{{- if eq $i 0}}
+{{end}}
+{{ template "entry" $change }}
+{{- end }}
+{{- end }}
+
+{{- if .BugFixes }}
+
+### Bug Fixes
+
+{{- range $i, $change := .BugFixes }}
+{{- if eq $i 0}}
+{{end}}
+{{ template "entry" $change }}
+{{- end }}
+{{- end }}
+
+{{- if .NewComponents }}
+
+### Docs
+
+{{- range $i, $change := .NewComponents }}
+{{- if eq $i 0}}
+{{end}}
+{{ template "entry" $change }}
+{{- end }}
+{{- end }}
+
+<!-- previous-version -->

.github/workflows/changelog.yaml

@@ -0,0 +1,115 @@
+# This action requires that any PR targeting the main branch should add a
+# yaml file to the ./.chloggen/ directory. If a CHANGELOG entry is not required,
+# or if performing maintenance on the Changelog, add the "Skip Changelog" label,
+# or prefix the pull request title with any of the following: "chore",
+# "build", "ci", "refactor", "style", "test".
+
+name: changelog
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, labeled, unlabeled, edited]
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+env:
+  # Make sure to exit early if cache segment download times out after 2 minutes.
+  # We limit cache download as a whole to 5 minutes.
+  SEGMENT_DOWNLOAD_TIMEOUT_MINS: 2
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref }}
+  cancel-in-progress: true
+
+jobs:
+  changelog:
+    runs-on: ubuntu-24.04
+    if: ${{ github.actor != 'dependabot[bot]' }}
+    env:
+      PR_HEAD: ${{ github.event.pull_request.head.sha }}
+
+    steps:
+      - name: Check if changelog exempt
+        id: check
+        env:
+          PR_TITLE: ${{ github.event.pull_request.title }}
+          PR_LABELS: ${{ toJSON(github.event.pull_request.labels.*.name) }}
+        run: |
+          CHLOG_EXEMPT_PREFIXES=('chore' 'build' 'ci' 'refactor' 'style' 'test')
+          for prefix in "${CHLOG_EXEMPT_PREFIXES[@]}"; do
+            if [[ "$PR_TITLE" == "$prefix"* ]]; then
+              echo "Title has exempt prefix '$prefix'; changelog not required."
+              echo "exempt=true" >> "$GITHUB_OUTPUT"
+              exit 0
+            fi
+          done
+
+          CHLOG_EXEMPT_LABELS=('Skip Changelog' 'dependencies')
+          for label in "${CHLOG_EXEMPT_LABELS[@]}"; do
+            if echo "$PR_LABELS" | grep -qF "\"$label\""; then
+              echo "PR has exempt label '$label'; changelog not required."
+              echo "exempt=true" >> "$GITHUB_OUTPUT"
+              exit 0
+            fi
+          done
+
+          echo "No exempt prefix or label; changelog required."
+          echo "exempt=false" >> "$GITHUB_OUTPUT"
+
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
+        with:
+          # Fetch complete history unless the PR is changelog-exempt.
+          fetch-depth: ${{ steps.check.outputs.exempt == 'true' && '1' || '0' }}
+      - uses: actions/setup-go@4a3601121dd01d1626a1e23e37211e3254c1c06c # v6.4.0
+        with:
+          go-version: oldstable
+          cache-dependency-path: "**/*.sum"
+
+      - name: Ensure no changes to CHANGELOG.md
+        if: ${{ steps.check.outputs.exempt != 'true' }}
+        run: |
+          if [[ "$(git diff --name-only "$(git merge-base origin/main "$PR_HEAD")" "$PR_HEAD" ./CHANGELOG*.md)" ]]
+          then
+            echo "CHANGELOG.md should not be directly modified."
+            echo "Please add a .yaml file to the ./.chloggen/ directory."
+            echo "Alternately, add the \"Skip Changelog\" label or prefix the pull request title with any of the following: \"chore\", \"build\", \"ci\", \"refactor\", \"style\", or \"test\"."
+            false
+          else
+            echo "CHANGELOG.md was not modified."
+          fi
+
+      - name: Ensure ./.chloggen/*.yaml addition(s)
+        if: ${{ steps.check.outputs.exempt != 'true' }}
+        run: |
+          excluded_yamls=(config.yaml TEMPLATE.yaml)
+          chloggen_yamls="$(git diff --diff-filter=AM --name-only "$(git merge-base origin/main "$PR_HEAD")" "$PR_HEAD" ./.chloggen)"
+          if [[ 1 -gt "$(echo "$chloggen_yamls" | grep \\.yaml | grep -vc -f <(printf '/%s$\n' "${excluded_yamls[@]}"))" ]]
+          then
+            echo "No changelog entry was added or changed in the ./.chloggen/ directory."
+            echo "Please add or edit an existing .yaml file in the ./.chloggen/ directory."
+            echo "See CONTRIBUTING.md for more details."
+            echo "Alternately, add \"chore:\" to the title of the pull request or add the \"Skip Changelog\" label if this job should be skipped."
+            false
+          else
+            echo "A changelog entry was added to the ./.chloggen/ directory."
+          fi
+
+      - name: Validate ./.chloggen/*.yaml changes
+        run: |
+          make chlog-validate \
+            || { echo "New ./.chloggen/*.yaml file failed validation."; exit 1; }
+
+      # In order to validate any links in the yaml file, render the config to markdown
+      - name: Render .chloggen changelog entries
+        if: ${{ steps.check.outputs.exempt != 'true' }}
+        run: make chlog-preview > changelog_preview.md
+      - name: Link Checker
+        if: ${{ steps.check.outputs.exempt != 'true' }}
+        id: lychee
+        uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2.8.0
+        with:
+          args: "--verbose --no-progress ./changelog_preview.md --config .github/lychee.toml"
+          failIfEmpty: false

.github/workflows/ci-base.yaml

@@ -75,6 +75,9 @@ jobs:
       - name: Tidy go.mod files
         run: go mod tidy
 
+      - name: Validate GitHub Actions hashes match
+        run: ./scripts/validate-actions-hashes.sh
+
       - name: Ensure goreleaser up to date
         run: make check
 

.github/workflows/ci-bump-component-versions.yaml

@@ -22,6 +22,7 @@ jobs:
             token: ${{ secrets.RELEASE_TOKEN }}
 
         - name: Import GPG key
+          if: ${{ !env.ACT }}
           uses: crazy-max/ghaction-import-gpg@2dc316deee8e90f13e1a351ab510b4d5bc0c82cd # v7
           with:
             gpg_private_key: ${{ secrets.OTELCOMM_BOT_GPG_PRIVATE_KEY_BASE64 }}
@@ -71,7 +72,7 @@ jobs:
             fi
 
         - name: Commit Component Version Bump
-          if: steps.bump_component_versions.outputs.has_changes == 'true'
+          if: ${{ !env.ACT && steps.bump_component_versions.outputs.has_changes == 'true' }}
           run: |
             # Check if branch exists remotely
             if git ls-remote --heads origin ${{ env.branch }} | grep -q ${{ env.branch }}; then
@@ -134,11 +135,31 @@ jobs:
 
               echo "Updated PR #$pr_number"
             else
-              echo "Creating new PR..."
+              echo "Creating new draft PR..."
               gh pr create \
+                --draft \
                 --title "$pr_title" \
                 --body "$pr_body" \
                 --repo "${{ github.repository }}" \
                 --base main \
                 --head "${{ env.branch }}"
             fi
+
+        # Changelog entry must be added after PR is created, so that its PR number may be added
+        - name: Add changelog entry
+          id: add_changelog_entry
+          if: ${{ steps.bump_component_versions.outputs.has_changes == 'true' }}
+          env:
+            GITHUB_TOKEN: ${{ secrets.RELEASE_TOKEN }}
+          run: |
+            ./scripts/generate-version-bump-chlog.sh -c "${{ env.current_beta_core }}" -n "${{ env.next_beta_core }}"
+
+        - name: Commit changelog entry
+          if: ${{ !env.ACT && steps.bump_component_versions.outputs.has_changes == 'true' }}
+          env:
+            GITHUB_TOKEN: ${{ secrets.RELEASE_TOKEN }}
+          run: |
+            git add .chloggen/
+            git commit -S -m "chore: add changelog entry for otel component version bump"
+            git push origin ${{ env.branch }}
+            gh pr ready "${{ env.branch }}" --repo "${{ github.repository }}"

.github/workflows/release-bump-version-pr.yaml

@@ -23,6 +23,7 @@ jobs:
           fetch-depth: 0
 
       - name: Import GPG key
+        if: ${{ !env.ACT }}
         uses: crazy-max/ghaction-import-gpg@2dc316deee8e90f13e1a351ab510b4d5bc0c82cd # v7
         with:
           gpg_private_key: ${{ secrets.OTELCOMM_BOT_GPG_PRIVATE_KEY_BASE64 }}
@@ -31,6 +32,12 @@ jobs:
           git_commit_gpgsign: true
           git_config_global: true
 
+      - name: Setup Go
+        uses: actions/setup-go@4a3601121dd01d1626a1e23e37211e3254c1c06c # v6.4.0
+        with:
+          go-version: "~1.26"
+          check-latest: true
+
       - name: Bump NRDOT version
         id: bump
         run: |
@@ -39,7 +46,13 @@ jobs:
           echo "old_version=${old_version}" >> $GITHUB_OUTPUT
           echo "branch=nrdot-release/${{ inputs.new_version }}" >> $GITHUB_OUTPUT
 
+      - name: Generate changelog
+        id: chloggen
+        run: |
+          make chlog-update
+          
       - name: Commit and push
+        if: ${{ !env.ACT }}
         run: |
           branch="${{ steps.bump.outputs.branch }}"
           git switch -c "${branch}"

.github/workflows/release-draft.yaml

@@ -69,13 +69,30 @@ jobs:
           go-version: "~1.26"
           check-latest: true
 
+      - name: Extract release notes
+        run: |
+          release_notes_file="${RUNNER_TEMP}/release-notes.md"
+
+          # Grab changelog from between version markers, then remove leading / trailing whitespace and print to temp file.
+          awk 'inside && /<!-- previous-version -->/{exit} inside{print} /<!-- next version -->/{inside=1}' CHANGELOG.md \
+          | awk 'NF{content=1} content{buf=buf $0 ORS} END{sub(/\n+$/,"\n",buf); printf "%s",buf}' > "$release_notes_file"
+
+          if [ ! -s "$release_notes_file" ]; then
+              echo "Error: no user-facing changes found between version markers in CHANGELOG.md; aborting release." >&2
+              exit 1
+          fi
+
+          echo "release_notes_file=$release_notes_file" >> "$GITHUB_ENV"
+          echo "Release notes:"
+          cat "$release_notes_file"
+
       - name: Draft Release From Root Config
         id: goreleaser
         uses: goreleaser/goreleaser-action@1a80836c5c9d9e5755a25cb59ec6f45a3b5f41a8 # v7
         with:
           distribution: goreleaser-pro
           version: "2.15.4"
-          args: --clean --timeout 2h
+          args: --clean --timeout 2h --release-notes="${{ env.release_notes_file }}"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           GORELEASER_KEY: ${{ secrets.GORELEASER_KEY }}

.goreleaser.yaml

@@ -16,34 +16,7 @@ release:
       - [ ] Any new artifact type is attached to the draft release (we filter on upload for expected file types)
     - [ ] Docker images for each distro have been published to ECR
     ### Publish Checklist
-    - [ ] Checklist has been reviewed and all items are complete.
     - [ ] Draft header has been removed.
     - [ ] Docker images for each distro have been published to docker hub and tagged as latest
-    - [ ] Slack notifications have been sent to appropriate channels
     - [ ] PR has been generated to update docs in [docs.newrelic.com](https://github.com/newrelic/docs-website/pulls)
     ###### !!! REMOVE THIS HEADER BEFORE PUBLISHING !!!
-changelog:
-  sort: asc
-  use: github
-  format: "{{ .Message }}"
-  groups:
-    - title: Features
-      regexp: "^.*(feat:|feat\\/|feat(\\([^\\)]*\\)):).*"
-      order: 0
-    - title: Bug Fixes
-      regexp: "^.*(fix:|fix\\/|fix(\\([^\\)]*\\)):).*"
-      order: 1
-    - title: Docs
-      regexp: "^.*(docs:|docs\\/|docs(\\([^\\)]*\\)):).*"
-      order: 2
-  filters:
-    exclude:
-      - "^ci"
-      - "^test"
-      - "^chore"
-      - "^refactor"
-      - "^style"
-      - "^perf"
-      - "^build"
-      - "^revert"
-      - "^deps"

CHANGELOG.md

@@ -0,0 +1,3 @@
+<!-- This file is autogenerated. See CONTRIBUTING.md for instructions to add an entry. -->
+
+<!-- next version -->