Skip to content

Migrate release notes to Help-Squeak-Project in the image. Complements Help-Squeak-Project-ct.103.#43

Draft
LinqLover wants to merge 1 commit into
squeak-smalltalk:squeak-trunkfrom
LinqLover:release-notes
Draft

Migrate release notes to Help-Squeak-Project in the image. Complements Help-Squeak-Project-ct.103.#43
LinqLover wants to merge 1 commit into
squeak-smalltalk:squeak-trunkfrom
LinqLover:release-notes

Conversation

@LinqLover

Copy link
Copy Markdown
Collaborator

No description provided.

Copilot AI review requested due to automatic review settings March 24, 2026 21:14

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Migrates release notes out of the repository/bundled artifacts and into the Squeak image (Help-Squeak-*), replacing the on-disk chunk file-outs and removing them from bundle assembly.

Changes:

  • Removes the release-notes/ chunk file-out contents (and README) from the repo.
  • Stops copying release-notes/ into the prepared image and bundled outputs; removes the related env var.
  • Adds a release-notes pointer file and updates CI path-ignore rules accordingly.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated no comments.

Show a summary per file
File Description
release-notes/README Removes guidance about editing chunk file-outs (folder content is removed).
release-notes/6.0 Deletes the 6.0 release notes chunk file-out from the repo.
release-notes/5.3 Deletes the 5.3 release notes chunk file-out from the repo.
release-notes/5.2 Deletes the 5.2 release notes chunk file-out from the repo.
release-notes/5.1 Deletes the 5.1 release notes chunk file-out from the repo.
release-notes/5.0 Deletes the 5.0 release notes chunk file-out from the repo.
release-notes/4.6 Deletes the 4.6 release notes chunk file-out from the repo.
release-notes/4.5 Deletes the 4.5 release notes chunk file-out from the repo.
release-notes Adds a single-line pointer to the in-image release notes (code:// link).
prepare_image.sh Stops copying release-notes/ into the temp image directory.
helpers_bundles.sh Stops bundling release-notes/ into produced bundles.
env_vars Removes RELEASE_NOTES_PATH variable.
.github/workflows/bundle.yml Removes release-notes/** from paths-ignore, affecting when bundle workflow runs.
Comments suppressed due to low confidence (3)

release-notes:1

  • Previously, release notes in this repo were stored as Squeak text chunk file-outs (lines prefixed with |, terminated with !, and often including ]style[...]). This new release-notes file is plain text, so any tooling expecting chunk format (e.g., file-in/help ingestion that previously consumed release-notes/*) will not be able to load it as a styled Text chunk. If this file is meant to be read by Squeak as a chunk, convert it to the expected chunk file-out format (including the leading | and chunk terminator). If it is only meant as a repository-level pointer for humans/CI, consider renaming to something explicitly plain-text (e.g., release-notes.txt or a README) and ensure no Squeak-side tooling still tries to file it in.
    release-notes:1
  • The PR title/description references Help-Squeak-Project (singular), but the pointer text says Help-Squeak-Projects (plural) and also hard-codes 'since Squeak 6.1'. Please align the package name and version claim with the actual in-image package/book name and the scope of this branch, to avoid producing a pointer that sends users to a non-existent help book/package or gives an incorrect migration/version statement.
    .github/workflows/bundle.yml:1
  • Removing release-notes/** from paths-ignore changes when the bundle workflow runs. If release-note edits are still considered 'documentation artifacts' that shouldn't trigger bundle builds, keep an ignore rule (updated to the new structure). Conversely, if the intent is specifically to trigger builds when the new root release-notes pointer changes, note that the removed glob would not have matched that file anyway—so you may want to explicitly ignore/include release-notes depending on the desired behavior.
name: Bundle

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@LinqLover

LinqLover commented Mar 24, 2026

Copy link
Copy Markdown
Collaborator Author

@marceltaeumel CI is green, could you merge this (or give me write access to the repo)? :-)

@LinqLover

Copy link
Copy Markdown
Collaborator Author

Hm, maybe we should preserve the existing release notes anyway to avoid breaking urls. There are various social media posts linking to https://github.com/squeak-smalltalk/squeak-app/blob/squeak-trunk/release-notes/6.0, for instance.

@LinqLover LinqLover marked this pull request as draft March 24, 2026 21:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants