Skip to content
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

Trivial: Remove changelog, add label requirement to PR template #714

Merged
merged 3 commits into from
Aug 2, 2022

Conversation

Garandor
Copy link
Contributor

@Garandor Garandor commented Jul 25, 2022

Signed-off-by: Adam Reif garandor@manta.network

Description

As it says on the tin.
relates to #661 as changelogs are now created only during release (using the L- labels) and not updated on every individual PR


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Linked to Github issue with discussion and accepted design OR have an explanation in the PR that describes this work.
  • Added one label out of the L- group to this PR
  • Added one or more labels out of A- and C- groups to this PR
  • Re-reviewed Files changed in the Github PR explorer.

Situational Notes:

  • If adding functonality, write unit tests!
  • If importing a new pallet, choose a proper module index for it, and allow it in BaseFilter. Ensure every extrinsic works from front-end. If there's corresponding tool, ensure both work for each other.
  • If needed, update our Javascript/Typescript APIs. These APIs are officially used by exchanges or community developers.
  • If modifying existing runtime storage items, make sure to implement storage migrations for the runtime and test them with try-runtime. This includes migrations inherited from upstream changes, and you can search the diffs for modifications of #[pallet::storage] items to check for any.
  • If runtime changes, need to update the version numbers properly:
    • authoring_version: The version of the authorship interface. An authoring node will not attempt to author blocks unless this is equal to its native runtime.
    • spec_version: The version of the runtime specification. A full node will not attempt to use its native runtime in substitute for the on-chain Wasm runtime unless all of spec_name, spec_version, and authoring_version are the same between Wasm and native.
    • impl_version: The version of the implementation of the specification. Nodes are free to ignore this; it serves only as an indication that the code is different; as long as the other two versions are the same then while the actual code may be different, it is nonetheless required to do the same thing. Non-consensus-breaking optimizations are about the only changes that could be made which would result in only the impl_version changing.
    • transaction_version: The version of the extrinsics interface. This number must be updated in the following circumstances: extrinsic parameters (number, order, or types) have been changed; extrinsics or pallets have been removed; or the pallet order in the construct_runtime! macro or extrinsic order in a pallet has been changed. You can run the metadata_diff.yml workflow for help. If this number is updated, then the spec_version must also be updated
  • Verify benchmarks & weights have been updated for any modified runtime logics

Signed-off-by: Adam Reif <garandor@manta.network>
@Garandor Garandor added C-enhancement Category: An issue proposing an enhancement or a PR with one A-automation Area: Issues and PRs related to Automation A-development Area: Development Resources and Upgrades L-nochangelog labels Jul 25, 2022
@Garandor Garandor changed the title Trivial: Remove changelog, add label requirement to PR tempalte Trivial: Remove changelog, add label requirement to PR template Jul 25, 2022
@Garandor Garandor added this to the v3.3.0 milestone Jul 25, 2022
@ghzlatarev
Copy link
Contributor

Thanks, please explain why we're doing this change, and focus on the why in all issue descriptions.

@Garandor Garandor self-assigned this Jul 27, 2022
Copy link
Contributor

@flame4 flame4 left a comment

Choose a reason for hiding this comment

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

Cool!

@ghzlatarev ghzlatarev merged commit 924b7ee into manta Aug 2, 2022
@ghzlatarev ghzlatarev deleted the Garandor-patch-3 branch August 2, 2022 09:23
@ghzlatarev ghzlatarev added the L-skip Log: Will be skipped on changelog generation label Aug 19, 2022
@ghzlatarev ghzlatarev mentioned this pull request Aug 19, 2022
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-automation Area: Issues and PRs related to Automation A-development Area: Development Resources and Upgrades C-enhancement Category: An issue proposing an enhancement or a PR with one L-skip Log: Will be skipped on changelog generation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants