Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[META] Introduction 👋 #51

Open
moul opened this issue Jun 22, 2020 · 4 comments
Open

[META] Introduction 👋 #51

moul opened this issue Jun 22, 2020 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@moul
Copy link
Owner

moul commented Jun 22, 2020

I regularly use this template for my different projects.
The root README.md is also a template file, so this issue is used to as README.md replacement :)

This template is personal and strongly coupled to myself with my name everywhere, it won't be a real nightmare to replace my name with yours, but I suggest you keep this repo as a reference, pick up your favorite ideas, and do one for yourself :)

What I'm proud of this repo is that it fits with most of my needs with very minimal changes so I can have my project set up in a few minutes.

FYI, here is the command I run just after creating a new repo based on this template:

for file in $(git grep golang-repo-template | cut -d: -f1 | sort -u); do
    sed -i'' s/golang-repo-template/NEWPROJECT/g $file
done

And if the repo is a library without any binary, I've additional things to do, i.e.:

  • removing some files: Dockerfile, package.json, .goreleaser.yml
  • updating some others: Makefile, .github/workflows/*.yml

That's it :)


Btw, feel free to comment this issue or open a new one if you have things to share, questions, suggestions, anything 👋

@moul moul self-assigned this Jun 22, 2020
@moul moul pinned this issue Jun 22, 2020
@moul moul added documentation Improvements or additions to documentation good first issue Good for newcomers and removed discussion labels Jun 22, 2020
@Delta456
Copy link

Thanks for your work! I will be using it in my module but I have a question. GitHub Action badge is not working for me. It just shows blank for a temporary solution. I was able to added the badge from other source.

My docs for go.dev.pkg is also broken. See Delta456/box-cli-maker#9

Hope you will be able to give a solution!

Thanks!

@moul
Copy link
Owner Author

moul commented Jun 29, 2020

Hi @Delta456

Thanks for your work! I will be using it in my module, but I have a question. GitHub Action badge is not working for me. It just shows blank for a temporary solution. I was able to add the badge from another source.

You need to replace CI from my README.md to Box CLI Maker

Here is the working one: [![CI](https://github.com/Delta456/box-cli-maker/workflows/Box%20CLI%20Maker/badge.svg)](https://github.com/Delta456/box-cli-maker/actions?query=workflow%3A"Box+CLI+Maker")

CI

My docs for go.dev.pkg is also broken. See Delta456/box-cli-maker#9

That's because pkg.go.dev is still linking to your version 1.2.0, you need to "tell" pkg.go.dev that you now have a new version, you can do it by using go get github.com/Delta456/[email protected] with GOPROXY=https://proxy.golang.org/ or just make a curl against the index.

If you give a look at my release github action workflow, you can see that the last step is to make it automatically from the CI -> https://github.com/moul/golang-repo-template/blob/master/.github/workflows/release.yml#L49-L56

Something/someone needs to call this URL: curl https://proxy.golang.org/github.com/Delta456/box-cli-maker/@v/v1.3.1.info

I just gave a try and I think there is a strange behavior due to the uppercase letter in your GitHub nickname, basically:

I'm sorry but I have no idea why this happens, the strange thing is that https://pkg.go.dev/github.com/Delta456/box-cli-maker?tab=doc is working but https://pkg.go.dev/github.com/Delta456/box-cli-maker?tab=doc isn't

I don't have this uppercase issue by myself so I won't pass more time on this, but I hope I helped you a little bit anyway, good luck!

@moul moul changed the title [META] Template Presentation [META] Template Presentation 👋 Jun 29, 2020
@Delta456
Copy link

I think I will lowercase my username and try again. Hope it does not break my links which are given everywhere.

Thanks for helping!

@Delta456
Copy link

@moul Heads up. My issue is solved. Thanks for your help!

@moul moul changed the title [META] Template Presentation 👋 [META] Introduction 👋 Sep 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants