[PR] Retire VendorGuideTask + the dead SHA fields, simplify Authoring a Guide [grails-static-website]

["jamesfredley (via GitHub)" <gi...@apache.org>]

jamesfredley opened a new pull request, #480:
URL: https://github.com/apache/grails-static-website/pull/480

   ## Summary
   
   `VendorGuideTask` was the bulk-import helper for Phase 10 of #354. Migration is at Phase 15, no re-vendoring has happened in any subsequent phase, and the modern guide-authoring workflow (e.g. the upcoming v8 fields guide) is hand-vendored - the task and its only collaborator (`SnippetVendoringIncludeProcessor`) have no remaining consumers.
   
   The SHA fields the task wrote (`conf/guides.yml` `sampleRef.sha`, `manifest.yml` `githubSha` + `sourceCommitDate`, `snippets/MANIFEST.yml` as a whole file) are also write-only at site-render time - they don't flow into rendered HTML or AsciiDoc attributes. Removing them eliminates the maintenance burden and **fixes the pre-existing `validateGuides` failure on master** (6 entries had abbreviated SHAs that failed the 40-char-hex check).
   
   ## Net diff
   
   **4,675 deletions, 31 insertions across 258 files.**
   
   ## What this removes
   
   | Item | Count |
   |---|---|
   | `VendorGuideTask.groovy` + `SnippetVendoringIncludeProcessor.groovy` | 2 files |
   | `snippets/MANIFEST.yml` (entire files) | 126 files |
   | Vendor-task wiring in `RenderGuidesPlugin` (`MIGRATION_GROUP`, `VENDOR_AGGREGATE_TASK`, `DEFAULT_GUIDES_WORKSPACE_REL`, `Wiring.vendorTaskNames`, the per-version registration block) | ~50 lines |
   | `ValidateGuidesTask.SHA_40_HEX` regex + the `sampleRef.sha` validation block | ~20 lines |
   | `sha:` lines in `conf/guides.yml` `sampleRef` blocks | 126 lines |
   | `githubSha:` + `sourceCommitDate:` lines across `manifest.yml` files | 252 lines |
   | `# Generated by :vendorGuide` stale headers | 123 lines |
   | Multi-line fixture-era comment block in `creating-your-first-grails-app/v6/manifest.yml` | ~10 lines |
   | README `Authoring a Guide` Tier 2/3 SHA-pinning machinery, replaced with a simpler two-flavour split (Documentation vs Documentation+sample-app) | ~20 lines net |
   
   ## What stays
   
   - `conf/guides.yml` `sampleRef.repo` + `sampleRef.branch` - drives the rendered "Get the Code" sidebar via `githubSlug`/`githubBranch`.
   - `manifest.yml` `githubSlug` + `githubBranch` - same.
   - All other `manifest.yml` fields (`title`, `subtitle`, `authors`, `category`, `publicationDate`, `tags`) which are exposed as AsciiDoc attributes.
   
   ## Verification
   
   ```bash
   ./gradlew validateGuides -PvalidationMode=both --no-configuration-cache
   # [validateGuides] mode=both: 84 guide(s) parsed, 0 SKIP-warned, 0 errors
   # BUILD SUCCESSFUL
   ```
   
   Two sampled guides re-rendered cleanly from scratch:
   
   ```bash
   ./gradlew renderGuide_creating_your_first_grails_app_6 renderGuide_grails_database_migration_6 --rerun-tasks --no-configuration-cache
   # BUILD SUCCESSFUL - 0 Unresolved directive errors across both guides
   ```
   
   ## Effect on contributing a new guide
   
   Before this PR, the README's Authoring section had three tiers and 12 numbered steps to navigate, plus mandatory SHA pinning for Tier 2/3 with three places to keep in sync.
   
   After: one section, one workflow, two flavours, and `sampleRef` is just `{repo, branch}`. The file count for a documentation-only guide drops by 1 (no `snippets/MANIFEST.yml`) and the line count for `conf/guides.yml` and every `manifest.yml` drops too.
   
   ## Coordinating with #479
   
   The grails-fields v8 guide PR (#479) currently includes the now-removed fields. I will rebase #479 to drop them as a follow-up commit on that branch once this PR lands (or fold them in if review prefers a single landing).


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@grails.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] Retire VendorGuideTask + the dead SHA fields, simplify Authoring a Guide [grails-static-website]

["jamesfredley (via GitHub)" <gi...@apache.org>]

jamesfredley merged PR #480:
URL: https://github.com/apache/grails-static-website/pull/480


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@grails.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org