kubo/assets
Peter Rabbitson 2d5f8b4ebe Include the git blob id of the dir-index bundle in the ETag
While the content of raw files retrieved via the gateway should never
change, the look and feel of the directory index can and will change
between versions of go-ipfs.

Incorporate the hash of assets/bindata.go into the ETag when appropriate
2020-05-25 18:42:07 +00:00
..
dir-index-html@e39165569c chore: update dir-index-html to v1.0.5 2020-05-05 11:32:23 -06:00
init-doc quick-start: fix typo 2020-04-06 03:15:45 +02:00
assets_test.go assets: move away from gx 2019-06-11 15:36:47 -07:00
assets.go Include the git blob id of the dir-index bundle in the ETag 2020-05-25 18:42:07 +00:00
bindata_dep.go chore(dep): update deps 2020-03-13 11:20:46 -07:00
bindata_version_hash.go Include the git blob id of the dir-index bundle in the ETag 2020-05-25 18:42:07 +00:00
bindata.go chore: update dir-index-html to v1.0.5 2020-05-05 11:32:23 -06:00
README.md add go mod tidy to readme directions 2020-05-05 12:00:54 -06:00

Assets loaded in with IPFS

This directory contains the go-ipfs assets:

  • Getting started documentation (init-doc).
  • Directory listing HTML template (dir-index-html git submodule).

These assets are compiled into bindata.go with go generate.

Re-generating

Do not edit the .go files directly.

Instead, edit the source files and use go generate from within the assets directory:

go generate .

Updating dir-index-html

Upstream: https://github.com/ipfs/dir-index-html

dir-index-html is a git submodule. To update, run the following commands from this directory.

> git -C dir-index-html pull
> git -C dir-index-html checkout vX.Y.Z # target version

Then, you'll need to commit the updated submodule before regenerating bindata.go. Otherwise, go generate will checkout the checked-in version of dir-index-html.

> git add dir-index-html
> git commit -m 'chore: update dir-index-html to vX.Y.Z'

Finally, re-generate the directory index HTML template, tidy, and amend the previous commit.

> go generate .
> git add bindata.go
> go mod tidy
> git commit --amend --no-edit