go-modules: Doc updates

This commit is contained in:
Colin L Rice 2020-05-07 23:13:49 -04:00 committed by Jörg Thalheim
parent 9761128d2d
commit c5f18c44b1
No known key found for this signature in database
GPG Key ID: 003F2096411B5F92
2 changed files with 14 additions and 7 deletions

View File

@ -36,7 +36,7 @@ pet = buildGoModule rec {
sha256 = "0m2fzpqxk7hrbxsgqplkg7h2p7gv6s1miymv3gvw0cz039skag0s"; sha256 = "0m2fzpqxk7hrbxsgqplkg7h2p7gv6s1miymv3gvw0cz039skag0s";
}; };
modSha256 = "1879j77k96684wi554rkjxydrj8g3hpp0kvxz03sd8dmwr3lh83j"; <co xml:id='ex-buildGoModule-1' /> vendorSha256 = "1879j77k96684wi554rkjxydrj8g3hpp0kvxz03sd8dmwr3lh83j"; <co xml:id='ex-buildGoModule-1' />
subPackages = [ "." ]; <co xml:id='ex-buildGoModule-2' /> subPackages = [ "." ]; <co xml:id='ex-buildGoModule-2' />
@ -56,7 +56,7 @@ pet = buildGoModule rec {
<calloutlist> <calloutlist>
<callout arearefs='ex-buildGoModule-1'> <callout arearefs='ex-buildGoModule-1'>
<para> <para>
<varname>modSha256</varname> is the hash of the output of the intermediate fetcher derivation. <varname>vendorSha256</varname> is the hash of the output of the intermediate fetcher derivation.
</para> </para>
</callout> </callout>
<callout arearefs='ex-buildGoModule-2'> <callout arearefs='ex-buildGoModule-2'>
@ -68,12 +68,12 @@ pet = buildGoModule rec {
</para> </para>
<para> <para>
<varname>modSha256</varname> can also take <varname>null</varname> as an input. <varname>vendorSha256</varname> can also take <varname>null</varname> as an input.
When `null` is used as a value, the derivation won't be a When `null` is used as a value, rather than fetching the dependencies
fixed-output derivation but disable the build sandbox instead. This can be useful outside and vendoring them, we use the vendoring included within the source repo.
of nixpkgs where re-generating the modSha256 on each mod.sum changes is cumbersome, If you'd like to not have to update this field on dependency changes,
but will fail to build by Hydra, as builds with a disabled sandbox are discouraged. run `go mod vendor` in your source repo and set 'vendorSha256 = null;'
</para> </para>
</section> </section>

View File

@ -98,6 +98,13 @@
</para> </para>
<itemizedlist> <itemizedlist>
<listitem>
<para>
The go-modules builder now uses vendorSha256 instead of modSha256 to pin
fetched version data. This is currently a warning, but will be removed in the next release.
</programlisting>
</para>
</listitem>
<listitem> <listitem>
<para> <para>
Grafana is now built without support for phantomjs by default. Phantomjs support has been Grafana is now built without support for phantomjs by default. Phantomjs support has been