Skip to content

Commit

Permalink
add vangen.json
Browse files Browse the repository at this point in the history
  • Loading branch information
dreamer-zq committed Jun 29, 2024
1 parent 458e330 commit 1dfd634
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 2 deletions.
7 changes: 5 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
name: TestUnit
on: [pull_request]

on:
pull_request:
paths:
- '**/*.go'
- '**/*.mod'
jobs:
test-unit:
name: Test Units
Expand Down
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#!/usr/bin/make -f

include scripts/build/build.mk
include scripts/build/godoc.mk
include scripts/build/contract.mk
include scripts/build/protobuf.mk
include scripts/build/testing.mk
Expand Down
12 changes: 12 additions & 0 deletions scripts/build/godoc.mk
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
vangen_version=v1.4.0

vangen-install:
@echo "--> Installing vangen $(vangen_version)"
@go install 4d63.com/vangen@$(vangen_version)

update-godocs:
@echo "--> Running update-godocs"
$(MAKE) vangen-install
@vangen -config vangen.json

.PHONY: update-godocs
30 changes: 30 additions & 0 deletions vangen.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"domain": "mods.irisnet.org",
"docsDomain": "pkg.go.dev",
"index": true,
"repositories": [
{
"prefix": "",
"subs": [
"api",
"simapp",
"modules/coinswap",
"modules/farm",
"modules/htlc",
"modules/mt",
"modules/nft",
"modules/random",
"modules/record",
"modules/service",
"modules/token"
],
"type": "git",
"url": "https://github.com/irisnet/irismod",
"source": {
"home": "https://github.com/irisnet/irismod",
"dir": "https://github.com/irisnet/irismod/tree/main{/dir}",
"file": "https://github.com/irisnet/irismod/blob/main{/dir}/{file}#L{line}"
}
}
]
}

0 comments on commit 1dfd634

Please sign in to comment.