From 5273fbe6d5170c0237bb595686a924f6cf33dba1 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Thu, 29 Sep 2022 15:37:12 -0700 Subject: [PATCH] update chloggen (#14581) --- {unreleased => .chloggen}/TEMPLATE.yaml | 0 ...ore_metrics_for_probabilistic_sampler.yaml | 0 ...authextension_support_token_from_file.yaml | 0 {unreleased => .chloggen}/feat-int-func.yaml | 0 .../fluentforwardreceiver-uint64-fix.yaml | 0 .../mongodbatlas-alerts-retrieval.yaml | 0 {unreleased => .chloggen}/ottl-generics.yaml | 0 ...nkhecreceiver-http-status-code-return.yaml | 0 .github/workflows/changelog.yml | 20 +++++++++---------- CONTRIBUTING.md | 8 ++++---- Makefile | 6 +++--- internal/tools/go.mod | 2 +- internal/tools/go.sum | 4 ++-- 13 files changed, 20 insertions(+), 20 deletions(-) rename {unreleased => .chloggen}/TEMPLATE.yaml (100%) rename {unreleased => .chloggen}/add_more_metrics_for_probabilistic_sampler.yaml (100%) rename {unreleased => .chloggen}/bearertokenauthextension_support_token_from_file.yaml (100%) rename {unreleased => .chloggen}/feat-int-func.yaml (100%) rename {unreleased => .chloggen}/fluentforwardreceiver-uint64-fix.yaml (100%) rename {unreleased => .chloggen}/mongodbatlas-alerts-retrieval.yaml (100%) rename {unreleased => .chloggen}/ottl-generics.yaml (100%) rename {unreleased => .chloggen}/splunkhecreceiver-http-status-code-return.yaml (100%) diff --git a/unreleased/TEMPLATE.yaml b/.chloggen/TEMPLATE.yaml similarity index 100% rename from unreleased/TEMPLATE.yaml rename to .chloggen/TEMPLATE.yaml diff --git a/unreleased/add_more_metrics_for_probabilistic_sampler.yaml b/.chloggen/add_more_metrics_for_probabilistic_sampler.yaml similarity index 100% rename from unreleased/add_more_metrics_for_probabilistic_sampler.yaml rename to .chloggen/add_more_metrics_for_probabilistic_sampler.yaml diff --git a/unreleased/bearertokenauthextension_support_token_from_file.yaml b/.chloggen/bearertokenauthextension_support_token_from_file.yaml similarity index 100% rename from unreleased/bearertokenauthextension_support_token_from_file.yaml rename to .chloggen/bearertokenauthextension_support_token_from_file.yaml diff --git a/unreleased/feat-int-func.yaml b/.chloggen/feat-int-func.yaml similarity index 100% rename from unreleased/feat-int-func.yaml rename to .chloggen/feat-int-func.yaml diff --git a/unreleased/fluentforwardreceiver-uint64-fix.yaml b/.chloggen/fluentforwardreceiver-uint64-fix.yaml similarity index 100% rename from unreleased/fluentforwardreceiver-uint64-fix.yaml rename to .chloggen/fluentforwardreceiver-uint64-fix.yaml diff --git a/unreleased/mongodbatlas-alerts-retrieval.yaml b/.chloggen/mongodbatlas-alerts-retrieval.yaml similarity index 100% rename from unreleased/mongodbatlas-alerts-retrieval.yaml rename to .chloggen/mongodbatlas-alerts-retrieval.yaml diff --git a/unreleased/ottl-generics.yaml b/.chloggen/ottl-generics.yaml similarity index 100% rename from unreleased/ottl-generics.yaml rename to .chloggen/ottl-generics.yaml diff --git a/unreleased/splunkhecreceiver-http-status-code-return.yaml b/.chloggen/splunkhecreceiver-http-status-code-return.yaml similarity index 100% rename from unreleased/splunkhecreceiver-http-status-code-return.yaml rename to .chloggen/splunkhecreceiver-http-status-code-return.yaml diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml index 691b59245fb0..8bed2effe2d6 100644 --- a/.github/workflows/changelog.yml +++ b/.github/workflows/changelog.yml @@ -1,5 +1,5 @@ # This action requires that any PR targeting the main branch should add a -# yaml file to the ./unreleased/ directory. If a CHANGELOG entry is not required, +# yaml file to the ./.chloggen/ directory. If a CHANGELOG entry is not required, # or if performing maintance on the Changelog, add either \"[chore]\" to the title of # the pull request or add the \"Skip Changelog\" label to disable this action. @@ -48,7 +48,7 @@ jobs: if [[ $(git diff --name-only $(git merge-base origin/main ${{ github.event.pull_request.head.sha }}) ${{ github.event.pull_request.head.sha }} ./CHANGELOG.md) ]] then echo "The CHANGELOG should not be directly modified." - echo "Please add a .yaml file to the ./unreleased/ directory." + echo "Please add a .yaml file to the ./.chloggen/ directory." echo "See CONTRIBUTING.md for more details." echo "Alternately, add either \"[chore]\" to the title of the pull request or add the \"Skip Changelog\" label if this job should be skipped." false @@ -56,26 +56,26 @@ jobs: echo "The CHANGELOG was not modified." fi - - name: Ensure ./unreleased/*.yaml addition(s) + - name: Ensure ./.chloggen/*.yaml addition(s) run: | - if [[ 1 -gt $(git diff --diff-filter=A --name-only $(git merge-base origin/main ${{ github.event.pull_request.head.sha }}) ${{ github.event.pull_request.head.sha }} ./unreleased | grep -c \\.yaml) ]] + if [[ 1 -gt $(git diff --diff-filter=A --name-only $(git merge-base origin/main ${{ github.event.pull_request.head.sha }}) ${{ github.event.pull_request.head.sha }} ./.chloggen | grep -c \\.yaml) ]] then - echo "No changelog entry was added to the ./unreleased/ directory." - echo "Please add a .yaml file to the ./unreleased/ directory." + echo "No changelog entry was added to the ./.chloggen/ directory." + echo "Please add a .yaml file to the ./.chloggen/ directory." echo "See CONTRIBUTING.md for more details." echo "Alternately, add either \"[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 ./unreleased/ directory." + echo "A changelog entry was added to the ./.chloggen/ directory." fi - - name: Validate ./unreleased/*.yaml changes + - name: Validate ./.chloggen/*.yaml changes run: | make chlog-validate \ - || { echo "New ./unreleased/*.yaml file failed validation."; exit 1; } + || { 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 unreleased changelog entries + - name: Render .chloggen changelog entries run: make chlog-preview > changelog_preview.md - name: Install markdown-link-check run: npm install -g markdown-link-check diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e1497970e78b..eb02e3d96982 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -45,19 +45,19 @@ No changelog entry: ### Adding a Changelog Entry -The [CHANGELOG.md](./CHANGELOG.md) file in this repo is autogenerated from `.yaml` files in the `./unreleased` directory. +The [CHANGELOG.md](./CHANGELOG.md) file in this repo is autogenerated from `.yaml` files in the `./.chloggen` directory. Your pull-request should add a new `.yaml` file to this directory. The name of your file must be unique since the last release. -During the collector release process, all `./unreleased/*.yaml` files are transcribed into `CHANGELOG.md` and then deleted. +During the collector release process, all `./.chloggen/*.yaml` files are transcribed into `CHANGELOG.md` and then deleted. **Recommended Steps** -1. Create an entry file using `make chlog-new`. This generates a file based on your current branch (e.g. `./unreleased/my-branch.yaml`) +1. Create an entry file using `make chlog-new`. This generates a file based on your current branch (e.g. `./.chloggen/my-branch.yaml`) 2. Fill in all fields in the new file 3. Run `make chlog-validate` to ensure the new file is valid 4. Commit and push the file -Alternately, copy `./unreleased/TEMPLATE.yaml`, or just create your file from scratch. +Alternately, copy `./.chloggen/TEMPLATE.yaml`, or just create your file from scratch. ## Adding New Components diff --git a/Makefile b/Makefile index 0ca4d42b2fdc..c54d5757f43a 100644 --- a/Makefile +++ b/Makefile @@ -269,7 +269,7 @@ chlog-install: FILENAME?=$(shell git branch --show-current) .PHONY: chlog-new chlog-new: chlog-install - chloggen new -filename $(FILENAME) + chloggen new --filename $(FILENAME) .PHONY: chlog-validate chlog-validate: chlog-install @@ -277,11 +277,11 @@ chlog-validate: chlog-install .PHONY: chlog-preview chlog-preview: chlog-install - chloggen update -dry + chloggen update --dry .PHONY: chlog-update chlog-update: chlog-install - chloggen update -version $(VERSION) + chloggen update --version $(VERSION) # Build the Collector executable. .PHONY: otelcontribcol diff --git a/internal/tools/go.mod b/internal/tools/go.mod index a7dcbb571f43..ed9151e8fb6c 100644 --- a/internal/tools/go.mod +++ b/internal/tools/go.mod @@ -11,7 +11,7 @@ require ( github.com/pavius/impi v0.0.3 github.com/tcnksm/ghr v0.16.0 go.opentelemetry.io/build-tools/checkdoc v0.0.0-20220706175322-58de0d25b85c - go.opentelemetry.io/build-tools/chloggen v0.0.0-20220909221141-2acdff3badaf + go.opentelemetry.io/build-tools/chloggen v0.0.0-20220928154055-b00fb8eb9066 go.opentelemetry.io/build-tools/crosslink v0.0.0-20220502161954-e2bf744925c0 go.opentelemetry.io/build-tools/issuegenerator v0.0.0-20210920164323-2ceabab23375 go.opentelemetry.io/build-tools/multimod v0.0.0-20220502161954-e2bf744925c0 diff --git a/internal/tools/go.sum b/internal/tools/go.sum index fbddad094330..7b8c793da349 100644 --- a/internal/tools/go.sum +++ b/internal/tools/go.sum @@ -761,8 +761,8 @@ go.opentelemetry.io/build-tools v0.0.0-20220321164008-b8e03aff061a h1:yLxbGYl9MX go.opentelemetry.io/build-tools v0.0.0-20220321164008-b8e03aff061a/go.mod h1:gkLviEngQuoeD670EP1KA/Oj4i5oNAzb+pjkk+4ecaQ= go.opentelemetry.io/build-tools/checkdoc v0.0.0-20220706175322-58de0d25b85c h1:F2goS5ItbVpxUlhINpRhpma+fkqua/G6DXHmOPIKYjQ= go.opentelemetry.io/build-tools/checkdoc v0.0.0-20220706175322-58de0d25b85c/go.mod h1:7dKPjDtQdVcaf/nIpESrRbPerImsk7ZmOmTrJvqLlR0= -go.opentelemetry.io/build-tools/chloggen v0.0.0-20220909221141-2acdff3badaf h1:D2c7ESeHRDdGZCupKQjEzd4b2Ma+k4FOLw/HiKTgJ18= -go.opentelemetry.io/build-tools/chloggen v0.0.0-20220909221141-2acdff3badaf/go.mod h1:alDl5UyigOgFQlov1PVwpOXnjadwNf49agUf0woGlsQ= +go.opentelemetry.io/build-tools/chloggen v0.0.0-20220928154055-b00fb8eb9066 h1:F6ZWUPWMTmQkc3EzNL8Dn1CZXobVWXrPveXs/UfIOtU= +go.opentelemetry.io/build-tools/chloggen v0.0.0-20220928154055-b00fb8eb9066/go.mod h1:qsKC2l0n7+Pta8GqKN9vHxMPHwknQH0tjAfJaW1KWaU= go.opentelemetry.io/build-tools/crosslink v0.0.0-20220502161954-e2bf744925c0 h1:yumJiwLmJ3xQXgvhywkGqkhbh9hbTsAWEuCGoRJi8bQ= go.opentelemetry.io/build-tools/crosslink v0.0.0-20220502161954-e2bf744925c0/go.mod h1:0mci40GSYELJTxavWNtFzuy2Z76uzf4dbT+1P0E8MAo= go.opentelemetry.io/build-tools/issuegenerator v0.0.0-20210920164323-2ceabab23375 h1:EZpYcHXE+pO4Ogfawlb6uEFFpQ2soJVNXS8tYfuvxUw=