diff --git a/.changelog/FORMAT_EXAMPLES.md b/.changelog/FORMAT_EXAMPLES.md new file mode 100644 index 00000000..73130483 --- /dev/null +++ b/.changelog/FORMAT_EXAMPLES.md @@ -0,0 +1,81 @@ +# Changelog Entry Format Examples + +This directory contains changelog entries using markdown format with code blocks. + +## Filename Format + +The name of the changelog file will comprise of `pr-` followed by the PR number, appended with a `.txt` extension. + +For example: `pr-2345.txt` + +## Format + +Each changelog entry file uses markdown code blocks with the `release-note:` syntax. Multiple entries can be included in a single file, each in its own code block. + +## Valid Types + +- breaking-change +- feature +- enhancement +- bug +- note +- security +- deprecation +- new-resource (new Terraform resource) +- new-data-source (new Terraform data source) +- new-guide (new Terraform guide) +- internal (tracked but not included in release notes) + +## Examples + +### Feature example + +````plaintext +```release-note:feature +Added new calculator function for advanced mathematical operations +``` +```` + +### Bug fix example + +````plaintext +```release-note:bug +Fixed issue where division by zero caused application crash +``` +```` + +### Breaking change example + +````plaintext +```release-note:breaking-change +Removed deprecated legacy API endpoints +``` +```` + +### Enhancement with resource reference + +````plaintext +```release-note:enhancement +`resource/pingone_risk_predictor`: Added the `predictor_device.should_validate_payload_signature` field to enforce requirement that the Signals SDK payload be provided as a signed JWT. +``` +```` + +### Multiple entries in one file + +````plaintext +```release-note:note +bump `github.com/example/sdk` 0.12.1 => 0.12.2 +``` + +```release-note:bug +`resource/example_gateway`: Fixed error when configuring gateways. +``` +```` + +### Internal change (not included in release notes) + +````plaintext +```release-note:internal +Refactored internal helper functions for better code organization +``` +```` diff --git a/.changelog/pr-153.txt b/.changelog/pr-153.txt new file mode 100644 index 00000000..9ae33612 --- /dev/null +++ b/.changelog/pr-153.txt @@ -0,0 +1,3 @@ +```release-note:internal +add submodule and implement common changelog process +``` diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 00000000..f6179c48 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "shared-configs"] + path = shared-configs + url = git@github-emu:ping-internal/cdi-shared-configs.git diff --git a/release-notes/README.md b/release-notes/README.md new file mode 100644 index 00000000..e4696d45 --- /dev/null +++ b/release-notes/README.md @@ -0,0 +1,19 @@ +# Release Notes + +This directory is used to store release notes for each version. + +The release notes for each version are stored in a subdirectory named after the release tag, following the format `vX.Y.Z`. + +Each release directory will contain the following two files: + +* `GITHUB_RELEASE.md`: The release notes formatted for GitHub Releases. +* `RELEASE_NOTES.adoc`: The release notes in AsciiDoc format. + +For example, the release notes for version 1.2.3 would be structured as follows: + +```text +release-notes/ +└── v1.2.3/ + ├── GITHUB_RELEASE.md + └── RELEASE_NOTES.adoc +``` diff --git a/shared-configs b/shared-configs new file mode 160000 index 00000000..aebba7c1 --- /dev/null +++ b/shared-configs @@ -0,0 +1 @@ +Subproject commit aebba7c1c5428c492e7be4806be42c1d0ce1cf2d