docs: update LOTUS_RELEASE_FLOW.MD document #12322

rjan90 · 2024-07-30T09:32:22Z

Related Issues

#12072

Proposed Changes

Update the LOTUS_RELEASE_FLOW document to account for the new release flow.

Checklist

Before you mark the PR ready for review, please make sure that:

Commits have a clear commit message.
PR title is in the form of of <PR type>: <area>: <change being made>
- example: fix: mempool: Introduce a cache for valid signatures
- PR type: fix, feat, build, chore, ci, docs, perf, refactor, revert, style, test
- area, e.g. api, chain, state, mempool, multisig, networking, paych, proving, sealing, wallet, deps
Update CHANGELOG.md or signal that this change does not need it.
- If the PR affects users (e.g., new feature, bug fix, system requirements change), update the CHANGELOG.md and add details to the UNRELEASED section.
- If the change does not require a CHANGELOG.md entry, do one of the following:
  - Add [skip changelog] to the PR title
  - Add the label skip/changelog to the PR
New features have usage guidelines and / or documentation updates in
- Lotus Documentation
- Discussion Tutorials
Tests exist for new functionality or change in behavior
CI is green

…egy items This was done as additional content to potentially add per #12322 . It includes content I saw in #12020 and #12072 that wasn't previously included.

BigLep

Good stuff here! Thanks for moving this forward. A few things:

I have some more sizable additions in docs: update LOTUS_RELEASE_FLOW with recent FAQs and branch/tag strategy items #12364 . (A lot of it is content I saw you write elsewhere.)
I didn't see any discussion about "lotus node" vs. "lotus miner" here.
I didn't see the TOC update. (I assume we use a standard vscode plugin to update this automatically?)

LOTUS_RELEASE_FLOW.md

…egy items (#12364) * docs: update LOTUS_RELEASE_FLOW with recent FAQs and branch/tag strategy items This was done as additional content to potentially add per #12322 . It includes content I saw in #12020 and #12072 that wasn't previously included. * Updates from self-review. * docs: Clarify node/miner release branching docs: Clarify node/miner release branching * Update LOTUS_RELEASE_FLOW.md Co-authored-by: Steve Loeppky <[email protected]> * Update LOTUS_RELEASE_FLOW.md Co-authored-by: Steve Loeppky <[email protected]> --------- Co-authored-by: Phi <[email protected]>

github-actions

Please update the PR title to match https://github.com/filecoin-project/lotus/blob/master/README.md#pr-title-conventions

github-actions

Please update the PR title to match https://github.com/filecoin-project/lotus/blob/master/CONTRIBUTING.md#pr-title-conventions

github-actions

Please update the PR title to match https://github.com/filecoin-project/lotus/blob/master/CONTRIBUTING.md#pr-title-conventions

BigLep · 2024-08-09T22:46:59Z

@rjan90 : FYI that I applied all my suggestions so it would be easier for me to make additional changes. The "conversations" are still open so you can review the changes and adjust as desired.

github-actions

Please update the PR title to match https://github.com/filecoin-project/lotus/blob/master/CONTRIBUTING.md#pr-title-conventions

BigLep · 2024-08-10T00:11:32Z

@rjan90 : I pushed some additional commits covering:

Discussion about "lotus node" vs. "lotus miner".
TOC handling
More deprecating releases discussion.
Other edits that saw

I did this here rather than a separate PR so I could link related deprecated releases work to just one PR. Feel free to undo / change anything I pushed.

Other things coming to mind 2024-08-09:

Maybe move this file into same place that the RELEASE_ISSUE_TEMPLATE file is rather than in top-level lotus? (Maybe good to do afterwards so the diff stays clean?)
Maybe link to this from CONTRIBUTING.md and/or README?

github-actions

Please update the PR title to match https://github.com/filecoin-project/lotus/blob/master/CONTRIBUTING.md#pr-title-conventions

PR title now matches the required format.

Preliminary update to the LOTUS_RELEASE_FLOW document

…egy items (#12364) * docs: update LOTUS_RELEASE_FLOW with recent FAQs and branch/tag strategy items This was done as additional content to potentially add per #12322 . It includes content I saw in #12020 and #12072 that wasn't previously included. * Updates from self-review. * docs: Clarify node/miner release branching docs: Clarify node/miner release branching * Update LOTUS_RELEASE_FLOW.md Co-authored-by: Steve Loeppky <[email protected]> * Update LOTUS_RELEASE_FLOW.md Co-authored-by: Steve Loeppky <[email protected]> --------- Co-authored-by: Phi <[email protected]>

These were self-committed to make it easier to propose additional changes on top.

Major items were answering: Why isn't Lotus Miner released more frequently? Why is the `releases` branch deprecated and what are alternatives?

Co-authored-by: Steve Loeppky <[email protected]>

fix: double spacing and minor typos

PR title now matches the required format.

fix(docs): link to LOTUS_RELEASE_FLOW.md from CONTRIBUTING.md

PR title now matches the required format.

BigLep · 2024-08-12T15:16:33Z

double spaces after a period

I was intentionally adding those because that was how I was taught to type 30 years ago. Searching "english double space after period" is hilarious though. I particularly liked this headline: "Nothing Says Over 40 Like Two Spaces after a Period!". I will have to kill this habit (and even typing this post I see myself doing it!)

grammatical fixes

I'll figure out a grammar checker within the vscode markdown editor so I can more of these myself.

Thanks for the help!

BigLep

I personally am good with the content we have and am adding an Approve in case that helps with merging. No worries though if there is additional changes you want to make.

PR title now matches the required format.

rjan90 changed the title ~~[WIP] docs: Update the LOTUS_RELEASE_FLOW.MD document~~ [WIP] docs: Update LOTUS_RELEASE_FLOW.MD document Jul 30, 2024

rjan90 added this to the DX-Streamline milestone Jul 30, 2024

rjan90 mentioned this pull request Jul 30, 2024

Revised Lotus Node/Client Versioning #12072

Closed

rjan90 self-assigned this Jul 31, 2024

BigLep mentioned this pull request Aug 9, 2024

docs: update LOTUS_RELEASE_FLOW with recent FAQs and branch/tag strategy items #12364

Merged

BigLep reviewed Aug 9, 2024

View reviewed changes

github-actions bot previously requested changes Aug 9, 2024

View reviewed changes

github-actions bot previously requested changes Aug 10, 2024

View reviewed changes

This comment was marked as duplicate.

Sign in to view

rjan90 changed the title ~~[WIP] docs: Update LOTUS_RELEASE_FLOW.MD document~~ docs: Update LOTUS_RELEASE_FLOW.MD document Aug 12, 2024

github-actions bot previously requested changes Aug 12, 2024

View reviewed changes

rjan90 changed the title ~~docs: Update LOTUS_RELEASE_FLOW.MD document~~ docs: update LOTUS_RELEASE_FLOW.MD document Aug 12, 2024

rjan90 and others added 8 commits August 12, 2024 13:04

Preliminary update to the LOTUS_RELEASE_FLOW document

4a37fa7

Preliminary update to the LOTUS_RELEASE_FLOW document

Apply @BigLep suggestions from code review

673922b

These were self-committed to make it easier to propose additional changes on top.

Apply remaining @BigLep suggestions from code review

e4d3ec7

Added terminology section

74061af

More editing

2175cee

Major items were answering: Why isn't Lotus Miner released more frequently? Why is the `releases` branch deprecated and what are alternatives?

Update LOTUS_RELEASE_FLOW.md

d350be7

Co-authored-by: Steve Loeppky <[email protected]>

fix: double spacing and minor typos

8272937

fix: double spacing and minor typos

rjan90 force-pushed the phi/update-release-flow branch from 4b6c31d to 8272937 Compare August 12, 2024 11:05

fix(docs): link to LOTUS_RELEASE_FLOW.md from CONTRIBUTING.md

d26b54f

fix(docs): link to LOTUS_RELEASE_FLOW.md from CONTRIBUTING.md

rjan90 mentioned this pull request Aug 12, 2024

refactor: adjust PR Title Check workflow to reduce noise #12373

Merged

BigLep mentioned this pull request Aug 12, 2024

chore: deprecate "releases" branch by providing clear messaging #12375

Merged

BigLep approved these changes Aug 12, 2024

View reviewed changes

rjan90 marked this pull request as ready for review August 12, 2024 18:24

rjan90 merged commit 2ecc690 into master Aug 12, 2024
89 checks passed

rjan90 deleted the phi/update-release-flow branch August 12, 2024 18:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: update LOTUS_RELEASE_FLOW.MD document #12322

docs: update LOTUS_RELEASE_FLOW.MD document #12322

rjan90 commented Jul 30, 2024 •

edited

Loading

BigLep left a comment

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

BigLep commented Aug 9, 2024

github-actions bot left a comment

BigLep commented Aug 10, 2024

This comment was marked as duplicate.

This comment was marked as duplicate.

github-actions bot left a comment

BigLep commented Aug 12, 2024

BigLep left a comment

docs: update LOTUS_RELEASE_FLOW.MD document #12322

docs: update LOTUS_RELEASE_FLOW.MD document #12322

Conversation

rjan90 commented Jul 30, 2024 • edited Loading

Related Issues

Proposed Changes

Checklist

BigLep left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

BigLep commented Aug 9, 2024

github-actions bot left a comment

Choose a reason for hiding this comment

BigLep commented Aug 10, 2024

This comment was marked as duplicate.

This comment was marked as duplicate.

github-actions bot left a comment

Choose a reason for hiding this comment

BigLep commented Aug 12, 2024

BigLep left a comment

Choose a reason for hiding this comment

rjan90 commented Jul 30, 2024 •

edited

Loading