Skip to content

docs: move release process to RELEASE.md #2196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Conversation

BigLep
Copy link
Member

@BigLep BigLep commented Aug 16, 2025

Summary

  • Move release documentation from CONTRIBUTING.md to dedicated RELEASE.md file
  • Remove outdated doc/ folder with M2 testnet-specific content
  • Update CONTRIBUTING.md to reference new RELEASE.md location

🤖 Generated with Claude Code

- Move release documentation from CONTRIBUTING.md to dedicated RELEASE.md file
- Remove outdated doc/ folder with M2 testnet-specific content
- Update CONTRIBUTING.md to reference new RELEASE.md location

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
@Copilot Copilot AI review requested due to automatic review settings August 16, 2025 02:23
@github-project-automation github-project-automation bot moved this to 📌 Triage in FilOz Aug 16, 2025
@BigLep BigLep self-assigned this Aug 16, 2025
@BigLep BigLep requested a review from LesnyRumcajs August 16, 2025 02:24
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR reorganizes release documentation by moving detailed release instructions from CONTRIBUTING.md to a dedicated RELEASE.md file and removes outdated M2 testnet-specific documentation.

  • Creates a dedicated RELEASE.md file with comprehensive release instructions for FVM crates
  • Removes outdated doc/ folder containing workspace diagrams and M2 testnet release processes
  • Updates CONTRIBUTING.md to reference the new RELEASE.md location

Reviewed Changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 9 comments.

File Description
RELEASE.md New file containing detailed release instructions moved from CONTRIBUTING.md
CONTRIBUTING.md Simplified to reference RELEASE.md instead of containing full release documentation
doc/workspace.dot Removed outdated workspace dependency diagram
doc/testnet-release-process.md Removed outdated M2 testnet-specific release documentation

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

RELEASE.md Outdated
1. `wokspace.dependencies→fvm→version`
2. `wokspace.dependencies→fvm_shared→version`
3. `wokspace.dependencies→fvm_sdk→version`
4. `wokspace.dependencies→fvm_integration_tests→version`
Copy link
Preview

Copilot AI Aug 16, 2025

Choose a reason for hiding this comment

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

Typo in 'wokspace' should be 'workspace'

Suggested change
4. `wokspace.dependencies→fvm_integration_tests→version`
1. `workspace.dependencies→fvm→version`
2. `workspace.dependencies→fvm_shared→version`
3. `workspace.dependencies→fvm_sdk→version`
4. `workspace.dependencies→fvm_integration_tests→version`

Copilot uses AI. Check for mistakes.

@codecov-commenter
Copy link

codecov-commenter commented Aug 16, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.56%. Comparing base (a633547) to head (7ad1d40).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2196   +/-   ##
=======================================
  Coverage   77.56%   77.56%           
=======================================
  Files         147      147           
  Lines       15789    15789           
=======================================
  Hits        12247    12247           
  Misses       3542     3542           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

2. Publish all [primary crates](#primary-crates) . For each crate (fvm, fvm_shared, fvm_sdk, fvm_integration_tests):

```bash
# Declare an associative array for crate_name → crate_directory
Copy link
Member

Choose a reason for hiding this comment

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

I can't help but feel this is a bit much, and just a list of 8 commands you modify and run would do the job; but I guess this illustrates it 🤷

Copy link
Member Author

Choose a reason for hiding this comment

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

Fair. This is just moving ower what was previously in CONTRIBUTING.md. For now I think we keep it knowing this is all about to get stripped down soon once we have better automation in place

@rjan90 rjan90 moved this from 📌 Triage to 🔎 Awaiting Review in FilOz Aug 18, 2025
@BigLep BigLep requested a review from rvagg August 19, 2025 05:00
@github-project-automation github-project-automation bot moved this from 🔎 Awaiting Review to ✔️ Approved by reviewer in FilOz Aug 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✔️ Approved by reviewer
Development

Successfully merging this pull request may close these issues.

4 participants