Skip to content

Add release packaging and project docs - #3

Closed
jayvenn21 wants to merge 1 commit into
cyber-shuttle:mainfrom
jayvenn21:atlas-materialize-nfs
Closed

Add release packaging and project docs#3
jayvenn21 wants to merge 1 commit into
cyber-shuttle:mainfrom
jayvenn21:atlas-materialize-nfs

Conversation

@jayvenn21

Copy link
Copy Markdown
Contributor

Summary

  • Add macOS/Linux release packaging through GitHub Actions
  • Add a local release packaging script for reviewable binary archives
  • Add developer, user, and distribution documentation
  • Link the new docs from the README

Details

This adds a release workflow that builds and tests platform binaries for Linux and macOS, packages the binary with examples and docs, and publishes artifacts to GitHub Releases when a v* tag is pushed.

The new docs cover:

  • repository structure and architecture
  • metadata registry and connector model
  • adding new table-backed datasets
  • local build/test instructions
  • install, materialize, FUSE, and NFS usage
  • known limitations
  • release checklist

Validation

  • cargo fmt -- --check
  • cargo test --locked
  • ./scripts/package-release.sh
  • Sample materialization smoke test with the release binary

@jayvenn21
jayvenn21 force-pushed the atlas-materialize-nfs branch from 1194ca8 to 7b3485b Compare August 12, 2026 01:22
@jayvenn21

Copy link
Copy Markdown
Contributor Author

Closing in favor of the consolidated final GSoC submission PR: #4

@jayvenn21 jayvenn21 closed this Aug 12, 2026
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.

1 participant