85 Commits

Author SHA1 Message Date
5582b1ae28 fix(docs): correct typos across whole doc (#12909)
* fix:typos

* fix: suggested change
2025-02-19 14:47:23 +01:00
99dcb127c3 docs(release): v1.30.0, v1.31.0 and v1.31.1 release template improvements (#12563)
* docs(release): v1.30.0 and v1.31.0 release template improvements

docs(release): v1.30.0 and v1.31.0 release template improvements

* docs(release): v1.31.1 release template improvements

docs(release): v1.31.1 release template improvements

* Update RELEASE_ISSUE_TEMPLATE.md

Co-authored-by: Steve Loeppky <biglep@filoz.org>

* Update RELEASE_ISSUE_TEMPLATE.md

Co-authored-by: Steve Loeppky <biglep@filoz.org>

* chore: remove post-release step

chore: remove post-release step

---------

Co-authored-by: Steve Loeppky <biglep@filoz.org>
2025-01-28 08:11:51 +01:00
ff620b0be5 chore(docs): fix minor typos (#12824) 2025-01-13 02:01:29 +00:00
f422705801 chore(docs): fix minor typos (#12820) 2025-01-10 05:06:27 +00:00
5e566ba8ae feat: generate default configs for docs without compiled binaries 2025-01-08 09:57:27 +11:00
942094cbf3 feat: separate docsgen-config Makefile target
still requires compiled binaries to produce the config, separate from
docsgen-cli which does not require them
2025-01-08 09:57:27 +11:00
4f29e2ecaa chore: more frequent migration progress logs (#12732) 2024-12-12 22:11:15 +11:00
dff8bfd6e1 ci: automate release issue creation (#12741)
* feat: automate release issue creation

* chore: run go mod tidy

* chore: organize imports in the release cmd

* fix: layout format given to the date parser

* ci: automate release issue creation from v1.32.0 learnings (#12749)

* ci: automate release issue creation from v1.32.0 learnings

* Self-review feedback from looking at https://github.com/filecoin-project/lotus/pull/12749

* Fix String contains ordering bugs.

* chore: run gofmt

---------

Co-authored-by: galargh <piotr.galar@gmail.com>

* fix: update workflow input parameters

* ci: use custom field types in the create issue workflow

* Update cmd/release/main.go

Co-authored-by: Rod Vagg <rod@vagg.org>

* Update cmd/release/main.go

Co-authored-by: Rod Vagg <rod@vagg.org>

* Incorporating rvagg@ comments

* Incorporating more feedback

---------

Co-authored-by: Steve Loeppky <biglep@filoz.org>
Co-authored-by: Rod Vagg <rod@vagg.org>
2024-12-05 21:47:55 -08:00
c6fdf956c5 chore: update network skeleton docs (#12631) 2024-10-24 08:40:15 +02:00
471819bf1e docs(actors): builtin-actors development docs (#12551)
* docs(actors): builtin-actors development docs

Ref: https://github.com/filecoin-project/builtin-actors/issues/1567

Co-authored-by: Steve Loeppky <biglep@filoz.org>
2024-10-04 08:58:30 +00:00
1f1afe5127 docs(release): v1.29.2 release template improvements (#12479)
* Update RELEASE_ISSUE_TEMPLATE.md

* chore: add example title in release issue template

chore: add example title in release issue template

---------

Co-authored-by: Phi <orjan.roren@gmail.com>
2024-10-03 10:53:25 -07:00
e14753c5fa docs: update network skeleton docs based on nv24 learnings (#12524)
* docs: summarizing how network upgrades impact Lotus and its key dependencies

* Formatting updates

* formatting

* added diagram

* Moved diagram up

* Update LOTUS_RELEASE_FLOW.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update documentation/misc/Building_a_network_skeleton.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update documentation/misc/Building_a_network_skeleton.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update documentation/misc/Building_a_network_skeleton.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Adding rust-filecoin-proofs-api and removing go-state-types dependency from ffi

* typos

* Added go-state-types back in as a dependency of ffi.

* docs: update network skeleton docs based on nv24 learnings

This includes some followups/learnings https://github.com/filecoin-project/lotus/pull/12481.

* cleanups

* formatting

* Update documentation/misc/Building_a_network_skeleton.md

---------

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>
2024-09-30 17:45:42 +00:00
6ccb1f1e52 docs: summarizing how network upgrades impact Lotus and its key dependencies (#12481)
* docs: summarizing how network upgrades impact Lotus and its key dependencies

* Formatting updates

* formatting

* added diagram

* Moved diagram up

* Update LOTUS_RELEASE_FLOW.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update documentation/misc/Building_a_network_skeleton.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update documentation/misc/Building_a_network_skeleton.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update documentation/misc/Building_a_network_skeleton.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Adding rust-filecoin-proofs-api and removing go-state-types dependency from ffi

* typos

* Added go-state-types back in as a dependency of ffi.

---------

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>
2024-09-30 07:58:11 -07:00
9b86cc5d60 docs(release): v1.29.1 release template improvements (#12473)
* docs: update release process based on v1.29.1 process

* Update RELEASE_ISSUE_TEMPLATE.md

Added in the things I saw from reading this again after going through it today with v1.29.1

* Additional updates about branch `branch` Version string updates
2024-09-17 10:20:27 -07:00
a39de1d87e docs: update release issue template with pointers to network upgrade info (#12461)
The goal is to get rid of posts like https://github.com/filecoin-project/lotus/discussions/12187 because we're just linking to other sources of truth.

This allows the removal of the "Lotus announcement upgrade" rows in the network upgrade template: https://docs.google.com/document/d/1KKJj2COb0vIqAQh-4F7fflJjxiTgGrU9oT9B461nsgg/edit
2024-09-13 16:36:19 -07:00
0cfc47dbb0 fix(doc): minor fix to release docs 2024-09-05 18:19:11 +10:00
49b57971b3 docs(release): v1.28.2 and v1.29.0 release template improvements (#12378)
* docs(release): v1.29.0 release template improvements

* Made the issue creation steps into more of a checklist.

* Differentiating patch vs. minor release steps

* Discuss opening this PR with whitespace early

* More places to be clear about node or miner

* chore: fix typos

chore: fix typos

* docs: learnings from prepping v1.29.0-rc1

docs: learnings from prepping v1.29.0-rc1

* fix: update with learnings from cutting v1.29.0 release

fix: update with learnings from cutting v1.29.0 release

---------

Co-authored-by: Phi <orjan.roren@gmail.com>
2024-09-03 10:46:58 -07:00
4a4ddaaecc docs: updates about branches and where to target PRs (#12416)
* docs: updates about branches and where to target PRs

CONTRIBUTING.md: calling out the release flow doc earlier and more of why a contributor should read it.
LOTUS_RELEASE_FLOW: being more precise and organized about branch strategy.
RELEASE_ISSUE_TEMPLATE: added comment on what we expect to see when backporting from release branch to master.

* Update LOTUS_RELEASE_FLOW.md

Co-authored-by: Rod Vagg <rod@vagg.org>

* Update LOTUS_RELEASE_FLOW.md

Co-authored-by: Rod Vagg <rod@vagg.org>

* Incorporating review feedback.  Stripped colors and made clear that we're cherry picking.

* Removed one more color reference

---------

Co-authored-by: Rod Vagg <rod@vagg.org>
2024-08-28 11:43:38 -07:00
a86129b935 refactor: adjust PR Title Check workflow to reduce noise (#12373)
* docs: update RELEASE_ISSUE_TEMPLATE.md base on v1.29.0 release execution

This is accumulating improvements based on lessons learned from executing https://github.com/filecoin-project/lotus/issues/12343

* Update RELEASE_ISSUE_TEMPLATE.md

* Update RELEASE_ISSUE_TEMPLATE.md

* fix(ci): allow periods in PR title scope

fix(ci): allow periods in PR title scope

* fix: add delay before dismissing PR title check review

Allows GitHub to properly register the review, addressing the issue where the review wasn't being dismissed despite the PR title being updated.

* fix: PR title check workflow to dismiss review only on title edit

PR title check workflow to dismiss review only on title edit

---------

Co-authored-by: Phi <orjan.roren@gmail.com>
2024-08-13 09:06:19 +02:00
67b7361c58 docs: release template: update based on 1.28 learnings (#12356)
This takes release issue changes and observations from https://github.com/filecoin-project/lotus/issues/12109 with also having an eye towards the upcoming release process changes per https://github.com/filecoin-project/lotus/issues/12072 .

The general goals here are:
1. Have a checkbox step for each step a releae engineer should take.
2. Reduce duplication in the template itself.  Where content should be duplicated, there is a comment for the issue creator to handle the copy/pasting.

* Removed experimental syntax testing.

* Update documentation/misc/RELEASE_ISSUE_TEMPLATE.md

* Update documentation/misc/RELEASE_ISSUE_TEMPLATE.md

* Update documentation/misc/RELEASE_ISSUE_TEMPLATE.md

* Update documentation/misc/RELEASE_ISSUE_TEMPLATE.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Update documentation/misc/RELEASE_ISSUE_TEMPLATE.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Addressing feedback about version string update in master

* Update documentation/misc/RELEASE_ISSUE_TEMPLATE.md

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>

* Clarifying with comments that backport step doesn't really apply to RC1.

* Cleanup Changelog prep steps.
Addded some commands for helping identify holes in changelog.

---------

Co-authored-by: Phi-rjan <orjan.roren@gmail.com>
2024-08-09 13:36:32 -07:00
4b75fa86b2 chore: docs: Update step in skeleton guide (#12349)
* chore: docs: Update dependencies in Lotus

chore: docs: Update dependencies in Lotus

* Update documentation/misc/Building_a_network_skeleton.md

Co-authored-by: Rod Vagg <rod@vagg.org>

---------

Co-authored-by: Rod Vagg <rod@vagg.org>
2024-08-07 07:27:09 +00:00
a6fd2eb86b feat: ci: automate the new release process (#12096)
Co-authored-by: Phi-rjan <orjan.roren@gmail.com>
2024-07-25 16:59:05 +10:00
5b52dbc090 Update Building_a_network_skeleton.md (#12280)
Update Building_a_network_skeleton.md with the steps needed for adding support for nvXX in lotus-shed cmd´s
2024-07-24 08:46:51 +02:00
7ea0e6cb82 chore: docs: fix typos (#12198)
Co-authored-by: fsgerse <173036932+fsgerse@users.noreply.github.com>
2024-07-11 11:55:14 +10:00
935a77f589 chore: docs: Add initial Update_Dependencies_Lotus.md (#12107)
* Add initial `Update_Dependencies_Lotus.md`

Add initial `Update_Dependencies_Lotus.md`

* Update the `Update_Dependecies_Lotus.md` file

Update the `Update_Dependecies_Lotus.md` file

* Update link to Filecoin-FFI release process

Update link to Filecoin-FFI release process

* Make sentence clearer

Co-authored-by: Steve Loeppky <biglep@protocol.ai>

* Make sentence clearer

Co-authored-by: Steve Loeppky <biglep@protocol.ai>

* Add backticks to versioning

Co-authored-by: Steve Loeppky <biglep@protocol.ai>

* Make sentence clearer

Co-authored-by: Steve Loeppky <biglep@protocol.ai>

* Update sentence

Co-authored-by: Steve Loeppky <biglep@protocol.ai>

* Add backticks to versioning

Co-authored-by: Steve Loeppky <biglep@protocol.ai>

* Update link

Co-authored-by: Steve Loeppky <biglep@protocol.ai>

* Update link

Co-authored-by: Steve Loeppky <biglep@protocol.ai>

* Add optional step in the Release_Issue_Template

Add optional step in the Release_Issue_Template that links to the Update_Dependencies_Lotus.md document

* Move Ref-FVM section before Filecoin-FFI

Move Ref-FVM section before Filecoin-FFI since it happens before updating Filecoin-FFI

* Update documentation/misc/Update_Dependencies_Lotus.md

Co-authored-by: Rod Vagg <rod@vagg.org>

---------

Co-authored-by: Steve Loeppky <biglep@protocol.ai>
Co-authored-by: Rod Vagg <rod@vagg.org>
2024-07-03 06:55:43 +00:00
b73d4e0481 docs:Building_a_network_skeleton.md cleanups (#12079)
* Building_a_network_skeleton.md cleanups
Go-State-Types Checklist updates

* Updated Lotus PR to the one that was merged for nv23

* Made network version substitute variable to consistently be "xx" instead of 3 or more "x"'s in some cases.
Adjusted ToC.

* Leaving ToC untouched

* Building_a_network_skeleton.md cleanups
Go-State-Types Checklist updates

* Made network version substitute variable to consistently be "xx" instead of 3 or more "x"'s in some cases.
Adjusted ToC.

* Leaving ToC untouched

* Building_a_network_skeleton.md cleanups
Go-State-Types Checklist updates

* Made network version substitute variable to consistently be "xx" instead of 3 or more "x"'s in some cases.
Adjusted ToC.
2024-06-17 08:15:31 -07:00
1b2dde1e65 chore: docs: Update skeleton guide (#11960)
* Updates to nv-skeleton guide

Updates to nv-skeleton guide

* Add link to FVM crates checklist

Add link to FVM crates checklist
2024-05-04 10:52:58 +02:00
ec6d3e1483 chore: docs: nv-skeleton documentation (#11065)
* nv-skeleton documentation

Add a tutorial for how one can create a nv-skeleton in Lotus

* Add footnote for `Add migration` step

Add footnote for `Add migration` step

* Indent migration-code

Indent migration-code to make it show properly as a footnote.

* Add ref-fvm and filecoin-ffi checklist

Add ref-fvm and filecoin-ffi checklist

* Add Filecoin-FFI steps

Add Filecoin-FFI steps

* Add step to params_butterfly.go

Add step to params_butterfly.go

* Fix typo

Fix typo

* Add links to reference PRs

Add links to reference PRs

* Update ref-fvm list

Update ref-fvm list
2024-04-25 15:46:13 -04:00
11cdb27bbb doc(release): minor doc updates to release process 2024-04-16 01:14:44 +10:00
Phi
3cb9b6c718 Add testing step
Call-out that testing of the RC should be done.
2024-03-26 09:26:50 +01:00
d5df13e66e Update documentation/misc/RELEASE_ISSUE_TEMPLATE.md
Co-authored-by: Rod Vagg <rod@vagg.org>
2024-03-26 09:26:50 +01:00
Phi
7e4b989e32 Update release_issue_template.md
Update release_issue_template.md
2024-03-26 09:26:50 +01:00
9387ffc593 Update RELEASE_ISSUE_TEMPLATE.md 2023-10-30 18:18:42 -05:00
d02b91e610 Update RELEASE_ISSUE_TEMPLATE.md 2023-09-06 11:58:35 -05:00
d463abae2f Merge pull request #11000 from filecoin-project/sbansal/update-release-template
chore: Extract stable release and post release portion outside of RC testing in template
2023-07-10 10:54:45 -04:00
13a65fdf56 feat: docs: add more steps to the release template 2023-07-04 16:08:21 -04:00
d5ae0905f9 feat: docs: include FFI steps in lotus RELEASE_ISSUE_TEMPLATE 2023-07-04 15:03:58 -04:00
5f6977af1a Extract stable release and post release portion outside of RC testing in template 2023-06-21 09:44:37 -04:00
7af42796db Update gas_balancing.md
correct the sentences
2023-05-26 20:12:10 +05:30
3636af4cd9 feat: Introduce nv19 skeleton
Update to go-state-types v0.11.0-alpha-1

Introduce dummy v11 actor bundles

Make new actors adapters

Add upgrade to Upgrade Schedules

make jen

Update to go-state-types v0.11.0-alpha-2
2023-03-29 16:13:41 -04:00
46cd0809e1 Update documentation/misc/RELEASE_ISSUE_TEMPLATE.md
Co-authored-by: Aayush Rajasekaran <arajasek94@gmail.com>
2022-11-17 12:02:22 -05:00
61ffbbc42d Update RELEASE_ISSUE_TEMPLATE.md 2022-11-16 16:12:04 -05:00
c0b7343e60 Merge branch 'release/v1.18.0' into asr/merge-release-into-master 2022-11-06 14:40:13 -05:00
dae7c538e2 docs: update actors_version_checklist.md 2022-10-22 23:41:52 +08:00
f4ed8476ef docs: release template: Mention codegen in release prep 2022-10-05 16:29:30 +00:00
e5e8308f5c Merge pull request #9150 from filecoin-project/phi/update-release-template
chore: release: Update `release_issue_template`
2022-09-28 16:03:55 +00:00
2bdab5a900 docs: release template: clarify location of version.go 2022-09-20 12:26:56 -04:00
Phi
a59d83518d Update release_issue_template
Update release_issue_template.

- Changed some wrong links (links pointed to version.go in IPFS-repo)
- Removed `Create a discussion for this release`
- Removed "Prep the changelog using `scripts/mkreleaselog`, and add it to `CHANGELOG.md`" since this already has been captured in the first pre-release step. Left that you should make sure that the CHANGELOG is up to date.
2022-08-10 14:44:14 +02:00
7330ac5d7e Merge pull request #7715 from filecoin-project/jen/simplythings
update release template
2022-06-17 05:10:26 -04:00
4df19f9686 address feedbacks + nit 2022-06-16 16:53:47 -04:00