docs(release): document source-package contents; ship root .gitignore#856
Merged
Merged
Conversation
Add docs/source-release-contents.md describing which repository-root metadata/config files ship in apache-magpie-<version>-source.zip and why, and which are export-ignored — following the 0.1.0-rc2 [VOTE] review discussion on dev@magpie.apache.org. Reference it from README. Also stop export-ignoring the repository-root .gitignore so it ships again as development-environment config (useful for a from-source dev checkout), and update the .gitattributes rationale comments to match.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/source-release-contents.mddescribing which repository-root metadata/config files ship inapache-magpie-<version>-source.zipand why (.rat-excludes,.asf.yaml,doap_Magpie.rdf,.apache-magpie.lock,.claude/settings.json, the skill-referenced.github/templates, the.gitignorefiles, and the.agents/skills/*view), plus what is deliberatelyexport-ignored and why.README.md.export-ignoreing the repository-root.gitignoreso it ships in the source archive again as development-environment config, and updates the.gitattributesrationale comments to match.Follows the
0.1.0-rc2[VOTE]review discussion ondev@magpie.apache.org, where the source archive's developer-facing files were flagged as potentially confusing and documenting them was the agreed follow-up.Type of change
docs/,README.md,CONTRIBUTING.md)Test plan
prek runpasses on the changed files (doctoc, SPDX header, markdownlint, typos, lychee link check, release-archive symlink-lint)git check-attr export-ignorethat the repository-root.gitignoreis no longer excluded whileprojects/_template/.gitignoreis unaffectedLinked issues
Refs the 0.1.0-rc2 [VOTE] thread on dev@magpie.apache.org (no tracking issue).