Fix scheduling descriptions to accurately reflect weekly checks

Co-authored-by: bookernath <[email protected]>

Author: Copilot

.changelogs/README.md

@@ -52,13 +52,16 @@ Each changelog entry is a JSON file containing:
 
 ### 3. Publishing Changelogs
 
-Changelogs are automatically aggregated and published on a regular cadence (every 2 weeks) via GitHub Actions:
+Changelogs are automatically checked weekly via GitHub Actions. When entries exist, they are published:
 
-- The workflow collects all entries from `.changelogs/entries/`
+- The workflow runs every Monday at 9 AM UTC
+- Collects all entries from `.changelogs/entries/`
 - Generates a formatted changelog document
 - Creates a PR with the aggregated changelog
 - Moves processed entries to `.changelogs/published/`
 
+This allows for flexible publishing - changelogs are created as soon as there's content to publish, rather than waiting for a specific schedule.
+
 ### 4. Manual Publishing
 
 To manually generate a changelog:
@@ -89,7 +92,7 @@ npm run changelog:publish
 The system includes several GitHub Actions workflows:
 
 - **changelog-entry-check.yml**: Validates that PRs with doc changes include changelog entries
-- **changelog-publish.yml**: Runs bi-weekly to aggregate and publish changelogs
+- **changelog-publish.yml**: Runs weekly (every Monday) to aggregate and publish changelogs if entries exist
 - **changelog-pr-helper.yml**: Auto-generates changelog entry templates from PR context
 
 ## Configuration

.changelogs/config.json

@@ -2,7 +2,7 @@
   "changelog": {
     "version": "1.0.0",
     "publishSchedule": "0 9 * * 1",
-    "publishScheduleDescription": "Every Monday at 9 AM UTC (bi-weekly)",
+    "publishScheduleDescription": "Every Monday at 9 AM UTC (weekly check, publishes if entries exist)",
     "entriesDir": ".changelogs/entries",
     "publishedDir": ".changelogs/published",
     "outputDir": "docs/changelog",

.github/workflows/changelog-publish.yml

@@ -2,7 +2,8 @@ name: Publish Changelog
 
 on:
   schedule:
-    # Run every two weeks on Monday at 9 AM UTC
+    # Run every Monday at 9 AM UTC (weekly check)
+    # Publishes a changelog only if there are entries to publish
     - cron: '0 9 * * 1'
   workflow_dispatch:
     inputs:

README.md

@@ -115,7 +115,7 @@ This repository uses an automated changelog management system to track documenta
 
 1. Create a changelog entry: `npm run changelog:add`
 2. Commit the entry with your changes
-3. Changelogs are automatically published bi-weekly
+3. Changelogs are automatically published weekly when entries exist
 
 For more information, see:
 - [Changelog Management Guide](/docs/changelog/GUIDE.md)

docs/changelog/GUIDE.md

@@ -18,7 +18,7 @@ The changelog management system automates the tracking and publishing of documen
 
 - **Individual changelog entries**: Create small, focused entries alongside documentation changes
 - **Automatic aggregation**: Combine entries into comprehensive changelogs
-- **Scheduled publishing**: Release changelogs on a regular cadence (bi-weekly)
+- **Scheduled publishing**: Release changelogs weekly when entries exist
 - **Direct documentation links**: Link to updated documentation pages, not PRs
 - **GitHub Actions automation**: Automatic validation and publishing
 
@@ -121,13 +121,16 @@ npm run changelog:validate 1730322000000-abc123.json
 ### Automatic Publishing (Recommended)
 
 The system automatically publishes changelogs:
-- **Schedule**: Every two weeks on Monday at 9 AM UTC
+- **Schedule**: Every Monday at 9 AM UTC
+- **Behavior**: Only publishes if there are entries to include
 - **Process**:
-  1. Collects all entries from `.changelogs/entries/`
-  2. Generates a formatted changelog in `docs/changelog/`
+  1. Checks for entries in `.changelogs/entries/`
+  2. If entries exist, generates a formatted changelog in `docs/changelog/`
   3. Creates a PR with the aggregated changelog
   4. Archives processed entries to `.changelogs/published/`
 
+This flexible approach means changelogs are published as soon as there's content, rather than waiting for a fixed schedule.
+
 ### Manual Publishing
 
 To manually trigger a changelog release:
@@ -179,7 +182,7 @@ To test the publishing workflow without creating a PR:
 #### Publish Changelog (`changelog-publish.yml`)
 
 - **Triggers**: 
-  - Scheduled: Every 2 weeks on Monday at 9 AM UTC
+  - Scheduled: Every Monday at 9 AM UTC (weekly check)
   - Manual: Via workflow dispatch
 - **Purpose**: Aggregates and publishes changelogs
 - **Actions**:

docs/changelog/README.mdx

@@ -4,7 +4,7 @@ Welcome to the BigCommerce Developer Documentation changelog. This section track
 
 ## About This Changelog
 
-This changelog is automatically generated from individual changelog entries created by our documentation team. Changes are published on a regular cadence, typically every two weeks.
+This changelog is automatically generated from individual changelog entries created by our documentation team. Changes are published weekly when updates are available.
 
 ## Change Categories