ipdx: auto update docs on version changes (support new release system) #746

laurentsenta · 2024-07-09T08:40:10Z

Fully automate version changes

provide a {{< version >}} shortcode that can be reused accross the repository
store the current version (lotus, miner, and go) in a resource file
load the lotus-cli and lotus-miner-cli markdown from github on build
provide a github workflow to auto-update the versions
- triggered every morning
- triggered on workflow_dispatch

(similar to our work on kubo, but even better thanks to Hugo's templating features)

test the workflow
confirm the latest release from github is the "highest semantic version" -- this is dealt with in @galargh's release PR

Contributes to filecoin-project/lotus#12072

laurentsenta · 2024-07-09T08:44:46Z

Test PR:
laurentsenta#1

after running a few times:
https://github.com/laurentsenta/lotus-docs/actions/workflows/update-version.yml

.github/workflows/update-version.yml

galargh · 2024-07-09T09:18:13Z

content/en/storage-providers/operate/lotus-miner-cli.md

@@ -1,7 +1,7 @@
 ---
 title: "Lotus-miner CLI"
 description: "Reference documentation for the lotus-miner command-line interface."
-lead: "Reference documentation for the lotus-miner command-line interface. This documentation was automatically generated using Lotus v1.27.0."
+lead: "Reference documentation for the lotus-miner command-line interface. This documentation was automatically generated using Lotus latest release."


Lotus Miner and Lotus Node releases are being split in filecoin-project/lotus#12010

Thanks for the heads up, I updated the code to deal with both. I guess we'll have to wait for at least one release to try the workflow end to end.

Yes, that makes sense. Thanks for making the changes.

laurentsenta · 2024-07-11T12:11:02Z

Tested in laurentsenta#2
With the new versions pulled from https://github.com/galargh/lotus/releases

laurentsenta · 2024-07-11T12:14:22Z

@galargh ~~we should be able to merge, the workflow will be working as soon as we complete a new release in the lotus repo. Until then the workflow will fail but that won't break the docs.~~

I spoke too soon, I forgot pulling the miner's doc rely on the new miner/vxxx tag existing too.

BigLep · 2024-08-16T16:40:33Z

@laurentsenta : There was a miner/ tag (https://github.com/filecoin-project/lotus/releases/tag/miner%2Fv1.28.2) published 2024-08-15, which we believe should help unblock the PR.

BigLep · 2024-09-09T23:01:24Z

Per 2024-08-26 meeting with IPDX, it was agreed that we should manually create a github release for the miner/v1.28.2 tag. (This was started in https://github.com/filecoin-project/lotus/releases/edit/untagged-53cb53b937b9699b4d38). This unblocks homebrew and this lotus-docs automation.

I believe a Lotus maintainer needs to do this. @rjan90 : are you ok to take it (or we do it in screenshot together)? I'm nervous to personally be doing GitHub releases through the UI without review.

galargh · 2024-09-11T10:38:16Z

Per 2024-08-26 meeting with IPDX, it was agreed that we should manually create a github release for the miner/v1.28.2 tag. (This was started in filecoin-project/lotus/releases/edit/untagged-53cb53b937b9699b4d38). This unblocks homebrew and this lotus-docs automation.

I believe a Lotus maintainer needs to do this. @rjan90 : are you ok to take it (or we do it in screenshot together)? I'm nervous to personally be doing GitHub releases through the UI without review.

If you could publish it, that would be great and it'd unblock this PR. I think it'd be better if lotus maintainer was present when that happens in case there's some community communication that needs to happen. You can ping me and we can do it together if you prefer.

rjan90 · 2024-09-12T12:58:08Z

Hey @galargh! I published the miner/v1.28.2 release now: https://github.com/filecoin-project/lotus/releases/tag/miner%2Fv1.28.2.

Let me know if you need any additional things

See filecoin-project/lotus-docs#746 and filecoin-project/homebrew-lotus#19

laurentsenta · 2024-09-18T08:14:26Z

Team, thanks for the update,

I'm waiting for add laurentsenta to homebrew and docs github-mgmt#76 to be able to update this branch and check the Fleek build succeeds.
Automation ran in Bump Lotus versions (node=1.29.1, miner=1.28.2) laurentsenta/lotus-docs#2
I'll update the PR with the commits in https://github.com/laurentsenta/lotus-docs/commits/main/

* add laurentsenta to homebrew and docs See filecoin-project/lotus-docs#746 and filecoin-project/homebrew-lotus#19 * fix@10918087956 [skip fix] * wrong repo --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: filecoin-project-mgmt-read-write[bot] <124318806+filecoin-project-mgmt-read-write[bot]@users.noreply.github.com> Co-authored-by: Steve Loeppky <biglep@filoz.org>

laurentsenta · 2024-09-25T12:49:32Z

@rjan90 @BigLep I've updated the PR, and we should be ready for review and merge.

Could you double-check, on the preview deploy, that content/en/lotus/manage/lotus-cli.md and content/en/storage-providers/operate/lotus-miner-cli.md are correctly loaded from Github on build.

If that's easier, please feel free to invite me to the fleek project I'll check this myself (firstname @ singulargarden.com)

rjan90

The changes here looks good! I just need to double-check the preview deploy on Fleek before merging (encountered some issues when trying to log-in)

rjan90 · 2024-09-25T15:09:13Z

Can confirm that I see the changes in the preview deploy on Fleek:

laurentsenta requested a review from galargh July 9, 2024 08:40

laurentsenta force-pushed the ipdx-auto-update-docs branch from 39bf050 to 4633938 Compare July 9, 2024 08:40

laurentsenta changed the title ~~ipdx: auto update docs~~ ipdx: auto update docs on version changes Jul 9, 2024

galargh reviewed Jul 9, 2024

View reviewed changes

laurentsenta changed the title ~~ipdx: auto update docs on version changes~~ ipdx: auto update docs on version changes (support new release system) Jul 9, 2024

laurentsenta force-pushed the ipdx-auto-update-docs branch from f06bf2e to f31d3cd Compare July 11, 2024 12:10

laurentsenta mentioned this pull request Jul 17, 2024

chore: Update Lotus CLI-pages to v1.28.1 #748

Merged

rjan90 mentioned this pull request Aug 5, 2024

Automatically update the lotus-miner CLI page #261

Closed

rjan90 linked an issue Aug 5, 2024 that may be closed by this pull request

Automatically update the lotus-miner CLI page #261

Closed

galargh assigned laurentsenta Aug 23, 2024

laurentsenta force-pushed the ipdx-auto-update-docs branch 2 times, most recently from b9117c0 to 48c55f9 Compare August 26, 2024 09:25

BigLep mentioned this pull request Sep 9, 2024

Revised Lotus Node/Client Versioning filecoin-project/lotus#12072

Closed

rjan90 mentioned this pull request Sep 16, 2024

Update minimum go-version in Docs #764

Closed

laurentsenta added a commit to laurentsenta/github-mgmt-4 that referenced this pull request Sep 18, 2024

add laurentsenta to homebrew and docs

5c3fa78

See filecoin-project/lotus-docs#746 and filecoin-project/homebrew-lotus#19

laurentsenta mentioned this pull request Sep 18, 2024

add laurentsenta to homebrew and docs filecoin-project/github-mgmt#76

Merged

4 tasks

laurentsenta added 5 commits September 25, 2024 14:40

feat: use a version data for go and lotus

0c96ecd

feat: pull cli content from API

c885607

ci: update version automatically

bb2f5cd

ci: drop the profile setup

a9c4dc1

docs: clean version

fcde6c2

laurentsenta and others added 8 commits September 25, 2024 14:40

ci: prepare for multiple versions

a357d47

chore: style

18be558

ci: fix multi-version

245939d

ci: update versions on push to main

7d9161d

ci: fix wording

1875c3d

ci: set to current version

a562078

ci: avoid escaping issues during bash expansion

91899bd

Bump Lotus versions to node=1.29.1, miner=1.28.2.

b4d2f97

laurentsenta force-pushed the ipdx-auto-update-docs branch from 48c55f9 to b4d2f97 Compare September 25, 2024 12:40

rjan90 approved these changes Sep 25, 2024

View reviewed changes

rjan90 merged commit 4f113ca into main Sep 25, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ipdx: auto update docs on version changes (support new release system) #746

ipdx: auto update docs on version changes (support new release system) #746

laurentsenta commented Jul 9, 2024 •

edited

Loading

laurentsenta commented Jul 9, 2024

galargh Jul 9, 2024 •

edited

Loading

laurentsenta Jul 9, 2024 •

edited

Loading

galargh Jul 10, 2024

laurentsenta commented Jul 11, 2024

laurentsenta commented Jul 11, 2024 •

edited

Loading

BigLep commented Aug 16, 2024

BigLep commented Sep 9, 2024

galargh commented Sep 11, 2024

rjan90 commented Sep 12, 2024

laurentsenta commented Sep 18, 2024 •

edited

Loading

laurentsenta commented Sep 25, 2024

rjan90 left a comment

rjan90 commented Sep 25, 2024

ipdx: auto update docs on version changes (support new release system) #746

ipdx: auto update docs on version changes (support new release system) #746

Conversation

laurentsenta commented Jul 9, 2024 • edited Loading

laurentsenta commented Jul 9, 2024

galargh Jul 9, 2024 • edited Loading

Choose a reason for hiding this comment

laurentsenta Jul 9, 2024 • edited Loading

Choose a reason for hiding this comment

galargh Jul 10, 2024

Choose a reason for hiding this comment

laurentsenta commented Jul 11, 2024

laurentsenta commented Jul 11, 2024 • edited Loading

BigLep commented Aug 16, 2024

BigLep commented Sep 9, 2024

galargh commented Sep 11, 2024

rjan90 commented Sep 12, 2024

laurentsenta commented Sep 18, 2024 • edited Loading

laurentsenta commented Sep 25, 2024

rjan90 left a comment

Choose a reason for hiding this comment

rjan90 commented Sep 25, 2024

laurentsenta commented Jul 9, 2024 •

edited

Loading

galargh Jul 9, 2024 •

edited

Loading

laurentsenta Jul 9, 2024 •

edited

Loading

laurentsenta commented Jul 11, 2024 •

edited

Loading

laurentsenta commented Sep 18, 2024 •

edited

Loading