Skip to content

Commit da9daf6

Browse files
committed
chore: include docs changes to changelog
1 parent be16fbe commit da9daf6

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

.github/workflows/changelog.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# yaml file to the ./.chloggen/ directory. If a CHANGELOG entry is not required,
33
# or if performing maintenance on the Changelog, add the "Skip Changelog" label,
44
# or prefix the pull request title with any of the following: "[chore]", "chore",
5-
# "build", "ci", "docs", "refactor", "style", "test".
5+
# "build", "ci", "refactor", "style", "test".
66

77
name: changelog
88

@@ -38,7 +38,7 @@ jobs:
3838
PR_TITLE: ${{ github.event.pull_request.title }}
3939
PR_LABELS: ${{ toJSON(github.event.pull_request.labels.*.name) }}
4040
run: |
41-
CHLOG_EXEMPT_PREFIXES=('[chore]' 'chore' 'build' 'ci' 'docs' 'refactor' 'style' 'test')
41+
CHLOG_EXEMPT_PREFIXES=('[chore]' 'chore' 'build' 'ci' 'refactor' 'style' 'test')
4242
for prefix in "${CHLOG_EXEMPT_PREFIXES[@]}"; do
4343
if [[ "$PR_TITLE" == "$prefix"* ]]; then
4444
echo "Title has exempt prefix '$prefix'; changelog not required."
@@ -73,12 +73,12 @@ jobs:
7373
run: |
7474
if [[ "$(git diff --name-only "$(git merge-base origin/main "$PR_HEAD")" "$PR_HEAD" ./CHANGELOG*.md)" ]]
7575
then
76-
echo "CHANGELOG.md and CHANGELOG-API.md should not be directly modified."
76+
echo "CHANGELOG.md should not be directly modified."
7777
echo "Please add a .yaml file to the ./.chloggen/ directory."
7878
echo "Alternately, add either \"chore:\" or \"[chore]\" to the title of the pull request or add the \"Skip Changelog\" label if this job should be skipped."
7979
false
8080
else
81-
echo "CHANGELOG.md and CHANGELOG-API.md were not modified."
81+
echo "CHANGELOG.md was not modified."
8282
fi
8383
8484
- name: Ensure ./.chloggen/*.yaml addition(s)

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The type must be one of the following:
4343
|--------------|---------------------------------------------------------------|--------------------|
4444
| **build** | Changes that affect the build system or external dependencies | no |
4545
| **ci** | Changes to CI configs and scripts | no |
46-
| **docs** | Documentation changes | no |
46+
| **docs** | Documentation changes | yes |
4747
| **feat** | A new feature | yes |
4848
| **fix** | A bug fix related to one of the distros | yes |
4949
| **perf** | A performance enhancement | yes |
@@ -62,7 +62,7 @@ This repository uses OpenTelemetry's `chloggen` tool to manage changelog entries
6262

6363
Pull requests which include user-facing changes must be accompanied by a changelog entry. If a changelog entry is not required, you may prefix your PR title with any of the conventional commit tags marked "no" in the table above, or add the `Skip Changelog` label.
6464

65-
During the release process, all changelog entries are transcribed in CHANGELOG.md and added to [NRDOT's release notes](https://docs.newrelic.com/docs/release-notes/nrdot-release-notes/).
65+
During the release process, all changelog entries are added to [NRDOT's release notes](https://docs.newrelic.com/docs/release-notes/nrdot-release-notes/).
6666

6767
## Contributor License Agreement
6868

0 commit comments

Comments
 (0)