-
Notifications
You must be signed in to change notification settings - Fork 19
feat: v1.1.0 FWSS upgrade scripts and documentation #384
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
rjan90
wants to merge
33
commits into
main
Choose a base branch
from
phi/document-upgrade
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
33 commits
Select commit
Hold shift + click to select a range
39619b2
feat: document FWSS upgrade process
rjan90 5f6154e
docs: enhance UPGRADE-PROCESS.md with detailed AFTER_EPOCH guidelines…
rjan90 a79de37
fix: wording in two-step upgrade
rjan90 608d91e
chore: remove thousands seperator
rjan90 cbc7641
chore: re-ordering upgrade processa
rjan90 33f824f
chore: bump FWSS-version and ServiceProviderRegistry
rjan90 20a168d
chore: update upgrade announcement workflow to include changelog PR i…
rjan90 f15a275
chore: remove action required input and changelog link from upgrade a…
rjan90 4b0253f
feat: enhance deploy-registry-calibnet.sh with proxy deployment option
rjan90 25ec0bf
feat: enhance deploy-warm-storage-implementation-only.sh to load defa…
rjan90 d49a18a
feat: enhance warm storage view scripts to load deployment defaults a…
rjan90 d8b9b6d
refactor: enhance deploy-registry-calibnet.sh for better network comp…
rjan90 6a774b8
feat: add network-specific USDFC token address handling in deploy-war…
rjan90 79055ef
chore: update version to 1.1.0 in ServiceProviderRegistry and Filecoi…
rjan90 3f41420
docs: update upgrade-process document
rjan90 38a0caf
feat: enhance upgrade announcement workflow with new upgrade options …
rjan90 77bf6dd
Update service_contracts/tools/UPGRADE-PROCESS.md
rjan90 41ee70d
Update service_contracts/tools/UPGRADE-PROCESS.md
rjan90 9d05a18
Update .github/workflows/upgrade-announcement.yml
rjan90 2141519
chore: remove deploy-registry-calibnet script
rjan90 18086d7
chore: make implementation "mode" wording clearer
rjan90 52d1947
chore: rename workflow to `create-upgrade-announcement-issue.yml`
rjan90 9827322
fix: address `UPGRADE-PROCESS` comments
rjan90 041c9ae
Update service_contracts/tools/UPGRADE-PROCESS.md
rjan90 a899196
Update service_contracts/tools/README.md
rjan90 2fc6bd3
fix: update migrate data handling in upgrade script
rjan90 67f2c33
Revert "fix: update migrate data handling in upgrade script"
rjan90 203e00d
fix: incorporate PR feedback in UPGRADE-PROCESS.md
rjan90 4191992
fix: notify stakeholders
rjan90 ea506df
refactor: extract upgrade announcement logic into standalone script
rjan90 08942c1
refactor: consolidate upgrade announcement into release issue format
rjan90 f8ffc6a
chore: address PR review comments
rjan90 627db4e
refactor: rename scripts with hierarchical prefixes (#414)
rjan90 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
103 changes: 103 additions & 0 deletions
103
.github/workflows/create-upgrade-announcement-issue.yml
rjan90 marked this conversation as resolved.
Show resolved
Hide resolved
|
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| name: Create Release Issue | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| inputs: | ||
rjan90 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| network: | ||
| description: 'Target network' | ||
| required: true | ||
| type: choice | ||
| options: | ||
| - Calibnet | ||
| - Mainnet | ||
| upgrade_type: | ||
| description: 'Type of upgrade' | ||
| required: true | ||
| type: choice | ||
| options: | ||
| - Routine | ||
| - Breaking Change | ||
| upgrade_registry: | ||
| description: '(Rare) Also upgrading ServiceProviderRegistry?' | ||
| required: false | ||
| type: boolean | ||
| default: false | ||
| upgrade_state_view: | ||
| description: '(Rare) Also redeploying FilecoinWarmStorageServiceStateView?' | ||
| required: false | ||
| type: boolean | ||
| default: false | ||
| after_epoch: | ||
| description: 'AFTER_EPOCH (block number after which upgrade can execute)' | ||
| required: true | ||
| type: string | ||
| changelog_pr: | ||
| description: 'PR number with changelog updates' | ||
| required: true | ||
| type: string | ||
| changes_summary: | ||
| description: 'Summary of changes (use | for multiple lines)' | ||
| required: true | ||
| type: string | ||
| action_required: | ||
| description: 'Action required for integrators (or "None" if no action needed)' | ||
| required: true | ||
| type: string | ||
| default: 'None' | ||
| release_tag: | ||
| description: 'Release tag if already created (usually added after upgrade completes)' | ||
| required: false | ||
| type: string | ||
| dry_run: | ||
| description: 'Dry run (preview issue without creating)' | ||
| required: false | ||
| type: boolean | ||
| default: false | ||
|
|
||
| jobs: | ||
| create-announcement: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| issues: write | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: '20' | ||
|
|
||
| - name: Create announcement issue | ||
| id: create_issue | ||
| env: | ||
| NETWORK: ${{ inputs.network }} | ||
| UPGRADE_TYPE: ${{ inputs.upgrade_type }} | ||
| UPGRADE_REGISTRY: ${{ inputs.upgrade_registry }} | ||
| UPGRADE_STATE_VIEW: ${{ inputs.upgrade_state_view }} | ||
| AFTER_EPOCH: ${{ inputs.after_epoch }} | ||
| CHANGELOG_PR: ${{ inputs.changelog_pr }} | ||
| CHANGES_SUMMARY: ${{ inputs.changes_summary }} | ||
| ACTION_REQUIRED: ${{ inputs.action_required }} | ||
| RELEASE_TAG: ${{ inputs.release_tag }} | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| GITHUB_REPOSITORY: ${{ github.repository }} | ||
| run: | | ||
| if [ "${{ inputs.dry_run }}" = "true" ]; then | ||
| node .github/scripts/create-upgrade-announcement.js --dry-run | ||
| else | ||
| node .github/scripts/create-upgrade-announcement.js | ||
| fi | ||
|
|
||
| - name: Summary | ||
| run: | | ||
| echo "## Release Issue ${{ inputs.dry_run == true && '(Dry Run)' || 'Created' }}" >> $GITHUB_STEP_SUMMARY | ||
| echo "" >> $GITHUB_STEP_SUMMARY | ||
| echo "**Network**: ${{ inputs.network }}" >> $GITHUB_STEP_SUMMARY | ||
| echo "**After Epoch**: ${{ inputs.after_epoch }}" >> $GITHUB_STEP_SUMMARY | ||
| echo "" >> $GITHUB_STEP_SUMMARY | ||
| if [ "${{ inputs.dry_run }}" = "true" ]; then | ||
| echo "This was a dry run. No issue was created." >> $GITHUB_STEP_SUMMARY | ||
| else | ||
| echo "See the created issue for full details." >> $GITHUB_STEP_SUMMARY | ||
| fi | ||
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
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
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
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
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
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
rjan90 marked this conversation as resolved.
Show resolved
Hide resolved
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add documentation about view contracts/addresses? I didn't see anything in https://github.com/FilOzone/filecoin-services/blob/9a18943b4390e37186fe0715789c38b364ce7f96/service_contracts/tools/README.md |
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.