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

Project Structure Rework (documentation, commits, branching, versioning) #10853

Closed

Conversation

PrivatePuffin
Copy link
Contributor

@PrivatePuffin PrivatePuffin commented Aug 30, 2020

Motivation, Context and Description

There are a lot of legacy inefficiencies in the current OpenZFS project structure.

In the past weeks i've submitted a number of automation reworks, but working on those a lot more came to light and it isn't feasable to create seperate PR's for every little change. I also came to the conclusion that some of the changes that are required are only relevant if seen in the context of a bigger picture, which was often lacking.

This PR is focussed on documenting and restructuringa lot of these issues.
It has not been squashed on purpose, to clearly seperate commits by purpose.

One of the side goals is to not increase the amount of effort or rules for users and maintainers significantly

Change shortlist:

Pre-merge requirements from maintainers:

This section lists things the maintainers need to add/change before this should be merged. Those aren't supposed to be big changes, but just things we can't fix with a PR.

How Has This Been Tested?

  • The stylecheck changes has been tested by the CI
  • The issue creator changes have been tested in a seperate repo

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Performance enhancement (non-breaking change which improves efficiency)
  • Code cleanup (non-breaking change which makes code smaller or more readable)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (a change to man pages or other documentation)

Checklist:

  • My code follows the ZFS on Linux code style requirements.
  • I have updated the documentation accordingly.
  • I have read the contributing document.
  • I have added tests to cover my changes.
  • I have run the ZFS Test Suite with this change applied.
  • All commit messages are properly formatted and contain Signed-off-by.

Closes #10845
Closes #10849
Closes #10852
Closes #10334
Signed-off-by: Kjeld Schouten-Lebbing [email protected]
Requires-builders: style

@PrivatePuffin PrivatePuffin mentioned this pull request Aug 30, 2020
12 tasks
@PrivatePuffin PrivatePuffin force-pushed the Semantic-Versioning branch 3 times, most recently from f93ea46 to 4149951 Compare August 30, 2020 14:15
@PrivatePuffin PrivatePuffin changed the title [WIP] Project Structure Rework (documentation, changelog, branching, versioning) Project Structure Rework (documentation, changelog, branching, versioning) Aug 30, 2020
@PrivatePuffin
Copy link
Contributor Author

Scope decreased:
Removed automation from this PR, release/changelog automation can only be merged right after OpenZFS2.0 release, or it would start messing with the release (because that release would be filled with commits missing any type tags etc.)

@PrivatePuffin PrivatePuffin marked this pull request as ready for review August 30, 2020 16:10
@PrivatePuffin PrivatePuffin changed the title Project Structure Rework (documentation, changelog, branching, versioning) Project Structure Rework (documentation, commits, branching, versioning) Aug 30, 2020
@codecov
Copy link

codecov bot commented Aug 30, 2020

Codecov Report

Merging #10853 into master will decrease coverage by 0.44%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #10853      +/-   ##
==========================================
- Coverage   80.37%   79.93%   -0.45%     
==========================================
  Files         293      395     +102     
  Lines       84962   125066   +40104     
==========================================
+ Hits        68289    99972   +31683     
- Misses      16673    25094    +8421     
Flag Coverage Δ
#kernel 80.43% <ø> (+0.05%) ⬆️
#user 66.15% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
module/zfs/zcp_set.c 87.09% <0.00%> (-12.91%) ⬇️
module/zfs/zfs_ratelimit.c 90.47% <0.00%> (-9.53%) ⬇️
module/zfs/zfs_byteswap.c 79.45% <0.00%> (-5.85%) ⬇️
module/zfs/dmu_redact.c 82.15% <0.00%> (-5.70%) ⬇️
module/zcommon/zfs_deleg.c 92.45% <0.00%> (-5.55%) ⬇️
module/zfs/dsl_deleg.c 89.70% <0.00%> (-4.46%) ⬇️
module/zfs/vdev_rebuild.c 93.69% <0.00%> (-4.44%) ⬇️
module/zfs/zio_inject.c 75.80% <0.00%> (-4.41%) ⬇️
module/zfs/fm.c 36.77% <0.00%> (-4.41%) ⬇️
module/zfs/spa_checkpoint.c 93.78% <0.00%> (-4.26%) ⬇️
... and 291 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7b8363d...a56c29f. Read the comment docs.

@behlendorf behlendorf added the Status: Design Review Needed Architecture or design is under discussion label Sep 2, 2020
@PrivatePuffin PrivatePuffin marked this pull request as draft September 22, 2020 16:07
@PrivatePuffin
Copy link
Contributor Author

Converted to draft due to #10965

kjeld Schouten-Lebbing added 4 commits September 29, 2020 12:21
As required for openzfs#10849 this commit documents the branching structure.
Also points out backport and release PR's against those branches exist.

Pre-merge requirements:
- Requires the main branch to be renamed to dev
- Requires a release branch to be created based on last release
- Requires a staging branch to be created based on 2.0 RC1

closes openzfs#10849
Signed-off-by: Kjeld Schouten-Lebbing <[email protected]>
Requires-builders: style
This commit does two things:
- It disabled blank issues
- It adds references to relevant mailinglist to the issue creator
- It adds references to IRQ to the issue creator

Pre-merge requirements:
- Open a OpenZFS discuss mailinglist

Signed-off-by: Kjeld Schouten-Lebbing <[email protected]>
Requires-builders: style
This commit adapts the contribution guidelines to be
fully Conventional Commits compatible.
changes coverity fixes to comply to Conventional Commits

It also adds clear guidelines for the commit types available.
And makes sure commits are types are checked on stylecheck

Closes openzfs#10852
Signed-off-by: Kjeld Schouten-Lebbing <[email protected]>
Requires-builders: style
- Explicitly implements semantic versioning
- Based on commit types in a release
- describes which commits can be backported

Closes openzfs#10334
Signed-off-by: Kjeld Schouten-Lebbing <[email protected]>
Requires-builders: style
@PrivatePuffin
Copy link
Contributor Author

Closing this in favor of all the previous and up-comming seperate patches.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Design Review Needed Architecture or design is under discussion
Projects
None yet
2 participants