go-modules-by-example / index Goto Github PK

Go modules by example is a series of work-along guides

License: BSD 3-Clause "New" or "Revised" License

Go 0.27% Shell 99.73%

index's Introduction

Go modules by example

Go modules by example is a series of work-along guides that look to help explain how Go modules work and how to get things done. They are designed to complement the official Go documentation and the Go modules wiki.

The guides are being released in no particular order and will instead be curated into a more cogent order/structure (in conjunction with the modules wiki) at a later date.

The release-ordered list of guides:

WIP guides:

Wikis:

Contributing

See Contributing.

Caveats

This project is work-in-progress. Feedback/PRs welcome.

Credits

With particular thanks (in no particular order) to:

index's People

Contributors

Stargazers

Watchers

Forkers

gocuntian shnwang chaitanyaphalak marwan-at-work killernova purohit lotapp acdsign xmgtony sevein myitcvforks jangwonpark74 someword muharihar suyyana stanxii mpls searking joseph-norman europelee rachitmehrotra isgasho andrewlu0210 qibobo asciiu hexingjie backwardn mcspx golang-info jro7 yjst2012 pana trinhtrannp daiguadaidai n3v3rf411 djordje-stoiljkovic thh waffleboot m-murad kedar700 gabyrod7 valery-barysok jstncbllr tschaub platinummonkey tonythere rocky-coalition montanaflynn harrisin2037 manhtran91 feng2012 clarkguan sirjoe arnarpall mithunkumarc zhaoshiling1017 yzainee-zz hmsvigle rafaelbeckel neurostep meanmangosteen icodein silenceshell mikedu1988 vishal1132 keeplearningandtrying gkarthiks ekopei cpretzer muddlebee 4everming ciorceri aniket22101996 rjpcasalino kvkang goodhut igrayson aetotvl6789 subhav wiyu ashba1995 kagia zeynab-sb grindlemire dkaslovsky 0xack13 jmizell badboyd godepsresolve

index's Issues

Be more atomic in our operations with example repos

At the moment we follow this sort of pattern at the start of an example:

now=$(date +'%Y%m%d%H%M%S_%N')
githubcli repo renameIfExists $GITHUB_ORG/$r ${r}_$now
githubcli repo transfer $GITHUB_ORG/${r}_$now $GITHUB_ORG_ARCHIVE
githubcli repo create $GITHUB_ORG/$r

But this means that for the entire of the regen of the example we are "missing" the real repo.

Instead we should switch to doing renames and transfers at the end of the example which will minimise downtime.

Switch to temp module for installing module-aware binaries

... until we settle on a solution to golang/go#24250

Share vendor between submodule

Thanks for the example, I have a question about submodule, can I have shared vendor between submodules? for example, I don't want every submodule to vendor some test util, and I want to manage the version of vendor globally, and How can I test all submodule in the main module?

"Tools as dependencies": go vet fails with "import "..." is a program, not an importable package"

The "Tools as dependencies" example: https://github.com/go-modules-by-example/index/blob/master/010_tools/README.md doesn't address go vet failing with import "..." is a program, not an importable package.

I can't see a way to disable that specific check in go vet.

I appreciate that go vet is based on heuristics and not perfect, however it is commonly used and developers want to be able to have their work pass go vet cleanly.

"Tools as dependencies": consider continuing to someone later using the repo and recreating the tool

The "Tools as dependencies" example:

https://github.com/go-modules-by-example/index/blob/master/010_tools/README.md

currently ends with committing and pushing the repo.

It could be helpful to continue to also show someone later using the repo to recreate the tool at the proper version. In other words, how to use a repo that has been set up with a tools.go.

Plans to finish the examples?

Hello @myitcv, I find this repo extremely useful, thanks! :-)
It seem that the activity has slowed down, I wanted to ask if you have plans (and time :-) to finish the examples?

Clarification about using the "modules download cache" instead of vendoring

The 012_modvendor intro includes this statement vis-a-vis vendoring:

In a modules world, the module download cache can be used as a higher fidelity source of module dependencies.

That sentence is a bit of a mind-blower. I'm unclear about how it can be higher fidelity; it seems that either the result of go mod vendor is correct or it isn't.

On the off chance that other folks are also confused, it'd be great if you can expand on the topic a bit. If you can clue me in I can write it up and PR it if that's easier for you.

Thanks!