Skip to content

Flat line CI/CD integration for Release Documentation#82

Merged
utkarsh232005 merged 4 commits into
KDM-cli:mainfrom
Yuvraj-Sarathe:feat/test-tag
May 19, 2026
Merged

Flat line CI/CD integration for Release Documentation#82
utkarsh232005 merged 4 commits into
KDM-cli:mainfrom
Yuvraj-Sarathe:feat/test-tag

Conversation

@Yuvraj-Sarathe
Copy link
Copy Markdown
Member

@Yuvraj-Sarathe Yuvraj-Sarathe commented May 19, 2026

Target Issue

Closes #79
Fixes the verification task for the flat-file changelog workflow engine.

Description

This PR finalizes and verifies the event-driven changelog.yml flat-file documentation pipeline. It completely restructures the tracking baseline to prevent syntax breaking and fully populates all historical version records.

Key Changes

  • Purged Static Tables & Broken Layouts: Overhauled docs/README.md to utilize a scalable, reverse-chronological unordered list for version indexing instead of the rigid markdown table syntax that caused formatting corruption during automation appending loops.
  • Removed Tracking URL Pollutants: Cleaned up broken hyperlink formatting that wrapped local files inside external Google Search query blocks, restoring them to strict local relative paths (v*.md).
  • Seeded Historical Production Releases: Automatically generated and checked in the real markdown changelog assets for all 4 genuine historical releases (v1.1.3, v1.2.0, v1.2.1, and v1.2.2) using the GitHub CLI interface.
  • Wiped Test Artifacts: Fully sanitized the directory of temporary prerelease test documentation remnants (v1.2.3-test and v1.2.4-test).

Verification & Testing Results

  • Validated the underlying array parsing mechanics (mapfile) and globbing safe-guards (shopt -s nullglob) under a forced pre-release webhook trigger.
  • Confirmed that the automated compilation runner successfully targets the --- separator line and builds a flawless, uncorrupted version history down the file layout dynamically.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 19, 2026

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (5)
  • docs/README.md is excluded by none and included by none
  • docs/v1.1.3.md is excluded by none and included by none
  • docs/v1.2.0.md is excluded by none and included by none
  • docs/v1.2.1.md is excluded by none and included by none
  • docs/v1.2.2.md is excluded by none and included by none

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: c27afdb9-fd55-4b69-9a39-7d6cb6839990

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Note

.coderabbit.yaml has unrecognized properties

CodeRabbit is using all valid settings from your configuration. Unrecognized properties (listed below) have been ignored and may indicate typos or deprecated fields that can be removed.

⚠️ Parsing warnings (1)
Validation error: Unrecognized key(s) in object: 'pre_merge_checks'
⚙️ Configuration instructions
  • Please see the configuration documentation for more information.
  • You can also validate your configuration using the online YAML validator.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 19, 2026
@Yuvraj-Sarathe
Copy link
Copy Markdown
Member Author

@utkarsh232005 review and merge please

@Yuvraj-Sarathe
Copy link
Copy Markdown
Member Author

@utkarsh232005, the readme I changed contained some commands. I suggest that if they are needed, you add them in the repository readme because their existence inside the docs directory does not make sense and would have been overwritten by the next release changelog only.

@utkarsh232005
Copy link
Copy Markdown
Member

@Yuvraj-Sarathe can we push this same to the kdm-website /docs folder whenever new release occurs the changelog written here will be shared with the kdm-website too show the changelogs on website also?

@utkarsh232005
Copy link
Copy Markdown
Member

@Yuvraj-Sarathe can we push this same to the kdm-website /docs folder whenever new release occurs the changelog written here will be shared with the kdm-website too show the changelogs on website also?

We can implement cross repo github action ci

@utkarsh232005 utkarsh232005 merged commit 9a0c107 into KDM-cli:main May 19, 2026
17 checks passed
@Yuvraj-Sarathe
Copy link
Copy Markdown
Member Author

@Yuvraj-Sarathe can we push this same to the kdm-website /docs folder whenever new release occurs the changelog written here will be shared with the kdm-website too show the changelogs on website also?

We can implement cross repo github action ci

Yes, we can do this using a cross-repos push. Whenever a release tag triggers the changelog engine here, we can have the GitHub Actions runner automatically authenticate against the kdm-website repo, drop the newly generated version markdown file directly into its /docs folder, and commit it.

But I have never worked with such things, so I lack experience here in how to execute it. Plus, if it is cross-repository, I am assuming only the owner of both repos can do this.

@Yuvraj-Sarathe Yuvraj-Sarathe deleted the feat/test-tag branch May 19, 2026 12:48
@Yuvraj-Sarathe Yuvraj-Sarathe self-assigned this May 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature]: ci: verify changelog automation workflow using a dummy tag

2 participants