-
Notifications
You must be signed in to change notification settings - Fork 165
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into add-msi-tests
- Loading branch information
Showing
16 changed files
with
578 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Use this changelog template to create an entry for release notes. | ||
|
||
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
change_type: | ||
|
||
# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver) | ||
component: | ||
|
||
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
note: | ||
|
||
# One or more tracking issues or pull requests related to the change | ||
issues: [] | ||
|
||
# (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: | ||
|
||
# Optional: The change log or logs in which this entry should be included. | ||
# e.g. '[user]' or '[user, api]' | ||
# Include 'user' if the change is relevant to end users. | ||
# Include 'api' if there is a change to a library API. | ||
# Default: '[user]' | ||
change_logs: [] | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# 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 | ||
|
||
# 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] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
# 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 maintance on the Changelog, add either \"[chore]\" to the title of | ||
# the pull request or add the \"Skip Changelog\" label to disable this action. | ||
|
||
name: changelog | ||
|
||
on: | ||
pull_request: | ||
types: [opened, synchronize, reopened, labeled, unlabeled] | ||
branches: | ||
- main | ||
|
||
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 | ||
# renovate: datasource=github-releases depName=tcort/markdown-link-check | ||
MD_LINK_CHECK_VERSION: "3.12.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: | ||
- uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 0 | ||
- uses: actions/setup-go@v5 | ||
with: | ||
go-version: "1.22.8" | ||
cache: false | ||
- name: Cache Go | ||
id: go-cache | ||
timeout-minutes: 5 | ||
uses: actions/cache@v4 | ||
with: | ||
path: | | ||
~/go/bin | ||
~/go/pkg/mod | ||
key: changelog-${{ runner.os }}-go-${{ hashFiles('**/go.sum') }} | ||
|
||
- name: Ensure no changes to the CHANGELOG.md or CHANGELOG-API.md | ||
if: ${{ !contains(github.event.pull_request.labels.*.name, 'dependencies') && !contains(github.event.pull_request.labels.*.name, 'Skip Changelog') && !contains(github.event.pull_request.title, '[chore]')}} | ||
run: | | ||
if [[ $(git diff --name-only $(git merge-base origin/main $PR_HEAD) $PR_HEAD ./CHANGELOG*.md) ]] | ||
then | ||
echo "CHANGELOG.md and CHANGELOG-API.md should not be directly modified." | ||
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 "CHANGELOG.md and CHANGELOG-API.md were not modified." | ||
fi | ||
- name: Ensure ./.chloggen/*.yaml addition(s) | ||
if: ${{ !contains(github.event.pull_request.labels.*.name, 'dependencies') && !contains(github.event.pull_request.labels.*.name, 'Skip Changelog') && !contains(github.event.pull_request.title, '[chore]')}} | ||
run: | | ||
if [[ 1 -gt $(git diff --diff-filter=A --name-only $(git merge-base origin/main $PR_HEAD) $PR_HEAD ./.chloggen | grep -c \\.yaml) ]] | ||
then | ||
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 ./.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: ${{ !contains(github.event.pull_request.labels.*.name, 'dependencies') && !contains(github.event.pull_request.labels.*.name, 'Skip Changelog') && !contains(github.event.pull_request.title, '[chore]')}} | ||
run: make chlog-preview > changelog_preview.md | ||
- name: Install markdown-link-check | ||
if: ${{ !contains(github.event.pull_request.labels.*.name, 'dependencies') && !contains(github.event.pull_request.labels.*.name, 'Skip Changelog') && !contains(github.event.pull_request.title, '[chore]')}} | ||
run: npm install -g markdown-link-check@${{ env.MD_LINK_CHECK_VERSION }} | ||
- name: Run markdown-link-check | ||
if: ${{ !contains(github.event.pull_request.labels.*.name, 'dependencies') && !contains(github.event.pull_request.labels.*.name, 'Skip Changelog') && !contains(github.event.pull_request.title, '[chore]')}} | ||
run: | | ||
markdown-link-check \ | ||
--verbose \ | ||
--config .github/workflows/check_links_config.json \ | ||
changelog_preview.md \ | ||
|| { echo "Check that anchor links are lowercase"; exit 1; } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
{ | ||
"ignorePatterns": [ | ||
{ | ||
"pattern": "http(s)?://\\d+\\.\\d+\\.\\d+\\.\\d+" | ||
}, | ||
{ | ||
"pattern": "http(s)?://localhost" | ||
}, | ||
{ | ||
"pattern": "http(s)?://example.com" | ||
}, | ||
{ | ||
"pattern": "#warnings" | ||
} | ||
], | ||
"aliveStatusCodes": [429, 200], | ||
"httpHeaders": [ | ||
{ | ||
"urls": ["https://docs.github.com/"], | ||
"headers": { | ||
"Accept-Encoding": "zstd, br, gzip, deflate" | ||
} | ||
} | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,3 +5,4 @@ dist/ | |
.generated-yaml/ | ||
.vscode | ||
.core | ||
.tools |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.