Skip to content

Run docs and man generation in CI - #194

Merged
thaJeztah merged 1 commit into
docker:masterfrom
dnephin:run-docs-gen-in-ci
Jun 15, 2017
Merged

Run docs and man generation in CI#194
thaJeztah merged 1 commit into
docker:masterfrom
dnephin:run-docs-gen-in-ci

Conversation

@dnephin

Copy link
Copy Markdown
Contributor

This way if we make changes to the scripts, or a docs change is invalid somehow we might be able to catch that problem in CI. We could probably do a little more validation on the output, but this is better than nothing.

Also cleanup the scripts a bit to be more consistent, and fail on errors.

@codecov-io

codecov-io commented Jun 14, 2017

Copy link
Copy Markdown

Codecov Report

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

@@ Coverage Diff @@## master #194 +/- ##
=======================================
Coverage 45.67% 45.67% =======================================
Files 171 171 Lines 11513 11513 =======================================
Hits 5259 5259 Misses 5947 5947 Partials 307 307

Comment threadscripts/docs/generate-man.sh Outdated

MD2MAN_REPO=github.com/cpuguy83/go-md2man
MD2MAN_COMMIT=$(grep -F "$MD2MAN_REPO" vendor.conf | cut -d' ' -f2)
MD2MAN_COMMIT=v1.0.6

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we bump the version in vendor.conf to the same? Was there a specific reason to not keep them in sync?

@dnephindnephinJun 14, 2017

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no version in vendor.conf anymore. If there was we could remove this go get entirely.

We could decide to include this in vendor.conf but it would warn on "unused package".

We could alternatively install it in the Dockerfile like we do with other binaries.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, apparently it is in the vendor.conf ... let me try this again.

Also cleanup the scripts a bit to be more consistent, and fail on errors.
Signed-off-by: Daniel Nephin <dnephin@docker.com>
@dnephin
dnephinforce-pushed the run-docs-gen-in-ci branch from cbfbbd7 to 343d836CompareJune 14, 2017 22:01
@dnephin

Copy link
Copy Markdown
ContributorAuthor

@thaJeztah thanks! I've fixed this up to use the code we already have in vendor. This is also faster because we don't have to go downloading anything.

@vdemeestervdemeester left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🐮

@thaJeztahthaJeztah left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@thaJeztah
thaJeztah merged commit 23a0e3b into docker:masterJun 15, 2017
@GordonTheTurtleGordonTheTurtle added this to the 17.07.0 milestone Jun 15, 2017
@dnephin
dnephin deleted the run-docs-gen-in-ci branch June 15, 2017 17:19
thaJeztah added a commit to thaJeztah/cli that referenced this pull request Jun 30, 2020
full diff: mitchellh/mapstructure@v1.0.0...v1.3.2
v1.3.2
- Decode into interface type with a struct value is supported [dockerGH-187]
v1.3.1
- Squash should only squash embedded structs. [dockerGH-194]
v1.3.0
- Added `",omitempty"` support. This will ignore zero values in the source
structure when encoding. [dockerGH-145]
v1.2.3
- Fix duplicate entries in Keys list with pointer values. [dockerGH-185]
v1.2.2
- Do not add unsettable (unexported) values to the unused metadata key
or "remain" value. [dockerGH-150]
v1.2.1
- Go modules checksum mismatch fix
v1.2.0
- Added support to capture unused values in a field using the `",remain"` value
in the mapstructure tag. There is an example to showcase usage.
- Added `DecoderConfig` option to always squash embedded structs
- `json.Number` can decode into `uint` types
- Empty slices are preserved and not replaced with nil slices
- Fix panic that can occur in when decoding a map into a nil slice of structs
- Improved package documentation for godoc
v1.1.2
- Fix error when decode hook decodes interface implementation into interface
type. [dockerGH-140]
v1.1.1
- Fix panic that can happen in `decodePtr`
v1.1.0
- Added `StringToIPHookFunc` to convert `string` to `net.IP` and `net.IPNet` [dockerGH-133]
- Support struct to struct decoding [dockerGH-137]
- If source map value is nil, then destination map value is nil (instead of empty)
- If source slice value is nil, then destination slice value is nil (instead of empty)
- If source pointer is nil, then destination pointer is set to nil (instead of
allocated zero value of type)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
thaJeztah added a commit to thaJeztah/cli that referenced this pull request Jun 30, 2020
full diff: mitchellh/mapstructure@v1.0.0...v1.3.2
v1.3.2
- Decode into interface type with a struct value is supported dockerGH-187
v1.3.1
- Squash should only squash embedded structs. dockerGH-194
v1.3.0
- Added `",omitempty"` support. This will ignore zero values in the source
structure when encoding. dockerGH-145
v1.2.3
- Fix duplicate entries in Keys list with pointer values. dockerGH-185
v1.2.2
- Do not add unsettable (unexported) values to the unused metadata key
or "remain" value. dockerGH-150
v1.2.1
- Go modules checksum mismatch fix
v1.2.0
- Added support to capture unused values in a field using the `",remain"` value
in the mapstructure tag. There is an example to showcase usage.
- Added `DecoderConfig` option to always squash embedded structs
- `json.Number` can decode into `uint` types
- Empty slices are preserved and not replaced with nil slices
- Fix panic that can occur in when decoding a map into a nil slice of structs
- Improved package documentation for godoc
v1.1.2
- Fix error when decode hook decodes interface implementation into interface
type. dockerGH-140
v1.1.1
- Fix panic that can happen in `decodePtr`
v1.1.0
- Added `StringToIPHookFunc` to convert `string` to `net.IP` and `net.IPNet` dockerGH-133
- Support struct to struct decoding dockerGH-137
- If source map value is nil, then destination map value is nil (instead of empty)
- If source slice value is nil, then destination slice value is nil (instead of empty)
- If source pointer is nil, then destination pointer is set to nil (instead of
allocated zero value of type)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
nobiit pushed a commit to nobidev/docker-cli that referenced this pull request Nov 19, 2025
[17.07] backport Fix requests for docker host ending with slash
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@dnephin@codecov-io@vdemeester@thaJeztah@GordonTheTurtle