chore: Cleanup the repo before releasing#3678
Conversation
There was a problem hiding this comment.
Pull request overview
This PR streamlines index-migration naming and updates the release tooling/docs to reflect a simplified “artifacts” set and more automated GitHub release-page editing.
Changes:
- Renames the storage migration helper to target only the passkey pubkey index and updates the migration to call it.
- Updates the upgrade proposal SOP script to auto-edit GitHub release title/body via the
ghCLI and cleans updidcinvocations. - Simplifies the release-notes GitHub Action/workflow inputs (drops the “production_asset” concept; focuses the notes table on a smaller asset list) and removes the README “Build Features and Flavors” section.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
src/internet_identity/src/storage.rs |
Renames/clarifies the force-sync helper to reflect the specific index being migrated. |
src/internet_identity/src/migrations/sync_anchor_indices.rs |
Updates migration logic/comments to use the renamed passkey pubkey index sync function. |
scripts/make-upgrade-proposal |
Adds an automated gh-based release text update step; adjusts didc calls. |
README.md |
Removes build features/flavors section and edits TOC (currently leaving broken internal links). |
HACKING.md |
Removes the reference to the removed README build-features/flavors section. |
.github/workflows/canister-tests.yml |
Updates inputs passed into the release-notes action (asset list + removes production_asset). |
.github/actions/release/run.sh |
Renames “Build flavors” section to “Artifacts” and removes production-asset-specific handling. |
.github/actions/release/README.md |
Updates local-try instructions to match action input changes. |
.github/actions/release/action.yml |
Removes production_asset input and cleans up composite action metadata. |
Comments suppressed due to low confidence (1)
scripts/make-upgrade-proposal:55
update_release_textis included inNOT_MOCKED_COMMANDS, which means it will run against the real GitHub release even whenMOCK_JSONis set (dry-run / mocked execution). Since this function performsgh release edit, it’s safer to allow it to be mocked (remove it fromNOT_MOCKED_COMMANDS) or gate the network-mutating parts behind an explicit opt-in flag.
NOT_MOCKED_COMMANDS=(
echo
printf
update_release_text
wait_for_archive_canister_hash
download_wasms
request_verification_command
deploy_release_candidate
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
There was a problem hiding this comment.
Pull request overview
This PR refines the passkey pubkey index migration API naming and streamlines the release/SOP tooling and documentation around published artifacts (removing “build flavors/features” messaging in favor of a simpler artifact list).
Changes:
- Rename the migration helper to specifically target the passkey pubkey index and update the migration code to call it.
- Automate GitHub release title/body updates in
make-upgrade-proposaland adjustdidcargument handling. - Simplify release notes/artifact documentation and workflow inputs (and remove “build features/flavors” sections from docs).
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
src/internet_identity/src/storage.rs |
Renames the force-sync helper to focus on passkey pubkey index only. |
src/internet_identity/src/migrations/sync_anchor_indices.rs |
Updates migration loop to call the renamed helper and adjusts comments. |
scripts/make-upgrade-proposal |
Adds gh-based release text update step; tweaks didc invocations and prompts. |
README.md |
Removes Build Features/Flavors section and related ToC entries; simplifies Docker build guidance. |
HACKING.md |
Removes reference to build features/flavors. |
.github/workflows/canister-tests.yml |
Reduces the asset list passed into the release-notes action; removes production_asset input usage. |
.github/actions/release/run.sh |
Renames “Build flavors” section to “Artifacts” and removes production-asset special casing. |
.github/actions/release/README.md |
Updates local usage example (drops INPUT_PRODUCTION_ASSET) and formatting. |
.github/actions/release/action.yml |
Removes production_asset input and reformats action metadata. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Adjust comments, code names, and CI release scripts.