Skip to content

Commit

Permalink
feat: separate docsgen-config Makefile target
Browse files Browse the repository at this point in the history
still requires compiled binaries to produce the config, separate from
docsgen-cli which does not require them
  • Loading branch information
rvagg committed Jan 6, 2025
1 parent 7fe23b0 commit 7c96bf3
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 6 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ jobs:
- run: git diff --exit-code
- run: make docsgen-cli
- run: git diff --exit-code
- run: make docsgen-config
- run: git diff --exit-code
check-lint:
name: Check (lint-all)
runs-on: ubuntu-latest
Expand Down
10 changes: 7 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ fiximports:

gen: actors-code-gen type-gen cfgdoc-gen docsgen api-gen
$(GOCC) run ./scripts/fiximports
@echo ">>> IF YOU'VE MODIFIED THE CLI OR CONFIG, REMEMBER TO ALSO RUN 'make docsgen-cli'"
@echo ">>> IF YOU'VE MODIFIED THE CLI OR CONFIG, REMEMBER TO ALSO RUN 'make docsgen-cli' and/or 'make docsgen-config'"
.PHONY: gen

jen: gen
Expand All @@ -348,11 +348,15 @@ snap: lotus lotus-miner lotus-worker
snapcraft
# snapcraft upload ./lotus_*.snap

docsgen-cli: lotus lotus-miner lotus-worker
docsgen-cli:
$(GOCC) run ./scripts/docsgen-cli
.PHONY: docsgen-cli

# Compiled lotus and lotus-miner are required to generate the default config files
docsgen-config: lotus lotus-miner
./lotus config default > documentation/en/default-lotus-config.toml
./lotus-miner config default > documentation/en/default-lotus-miner-config.toml
.PHONY: docsgen-cli
.PHONY: docsgen-config

print-%:
@echo $*=$($*)
Expand Down
2 changes: 1 addition & 1 deletion documentation/misc/Building_a_network_skeleton.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ Note: one only needs to update `filecion-ffi`'s dependency on `go-state-types` w
11. Run `make gen`.
12. Run `make docsgen-cli`.
12. Run `make docsgen-cli docsgen-config`.
And you're done! These are all the steps necessary to create a network upgrade skeleton that you will be able to run in a local devnet, and creates a basis where you can start testing new FIPs. When running a local developer network from this Lotus branch, bringing in all it dependencies, you should be able to:
Expand Down
4 changes: 2 additions & 2 deletions documentation/misc/RELEASE_ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@
<!--{{ if contains "Miner" .Type}}-->
- Ensure to update `MinerBuildVersion`
<!--{{ end}}-->
- [ ] Run `make gen && make docsgen-cli` before committing changes.
- [ ] Run `make gen && make docsgen-cli docsgen-config` before committing changes.
- [ ] Update the CHANGELOG
- [ ] Change the `UNRELEASED` section header to `UNRELEASED v{{.Tag}}`
- [ ] Set the `UNRELEASED v{{.Tag}}` section's content to be "_See https://github.com/filecoin-project/lotus/blob/release/v{{.Tag}}/CHANGELOG.md_"
Expand Down Expand Up @@ -118,7 +118,7 @@
<!-- {{if contains "Miner" $.Type}}-->
- Ensure to update `MinerBuildVersion`
<!-- {{end}}-->
- [ ] Run `make gen && make docsgen-cli` to generate documentation
- [ ] Run `make gen && make docsgen-cli docsgen-config` to generate documentation
- [ ] Create a draft PR with title `build: release Lotus {{$.Type}} v{{$.Tag}}{{$tagSuffix}}`
- Link to PR:
- Opening a PR will trigger a CI run that will build assets, create a draft GitHub release, and attach the assets.
Expand Down

0 comments on commit 7c96bf3

Please sign in to comment.