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

docs: fix default ldflag template #1265

Merged
merged 1 commit into from Nov 28, 2019
Merged

docs: fix default ldflag template #1265

merged 1 commit into from Nov 28, 2019

Conversation

leighmcculloch
Copy link
Contributor

What

Change the default ldflags template that is displayed in the build docs to
show that the default sets main.commit to Commit instead of
ShortCommit.

Why

The docs state that the default ldflags includes the ShortCommit but in
reality the code uses the longer Commit value instead. This behavior has
existed since the defaults were introduced ~3 years ago in commit
4af2cb0 so even if short commit was the intended behavior, after 3 years
of it working this way we should probably just update the docs to reflect
the actual default.

Fixes #1264

The docs state that the default ldflags includes the ShortCommit but in
reality the code uses the longer Commit value instead. This behavior has
existed since the defaults were introduced ~3 years ago in commit
4af2cb0.

Fixes #1264
@codecov-io
Copy link

codecov-io commented Nov 27, 2019

Codecov Report

Merging #1265 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1265   +/-   ##
=======================================
  Coverage   83.75%   83.75%           
=======================================
  Files          58       58           
  Lines        3342     3342           
=======================================
  Hits         2799     2799           
  Misses        461      461           
  Partials       82       82

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 36126ec...9450ff4. Read the comment docs.

@caarlos0 caarlos0 changed the title fix: docs about default ldflag template docs: fix default ldflag template Nov 28, 2019
@caarlos0 caarlos0 merged commit 6a759c1 into goreleaser:master Nov 28, 2019
@caarlos0
Copy link
Member

thanks!

@leighmcculloch leighmcculloch deleted the fixissue1264 branch November 28, 2019 00:38
@github-actions
Copy link
Contributor

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 19, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ldflags default includes Commit instead of ShortCommit
3 participants