Skip to content

Conversation

mabaasit
Copy link
Contributor

@mabaasit mabaasit commented Oct 26, 2021

Implement manual pages for the packages.

Adds mongosh manpages to all the packages except for win32msi.

For .deb
image

@mabaasit mabaasit marked this pull request as ready for review October 27, 2021 13:01
Copy link
Collaborator

@addaleax addaleax left a comment

Choose a reason for hiding this comment

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

If I extract the .deb locally, it seems that ./usr/share/man/man1/mongosh.1.gz is a tar archive, not a gzipped file? I think some of the wiring is still not quite right here:

$ dpkg -x mongodb-mongosh_0.0.0-dev.0_amd64.deb .
$ file ./usr/share/man/man1/mongosh.1.gz
./usr/share/man/man1/mongosh.1.gz: POSIX tar archive

@mabaasit mabaasit changed the title feat(manfile): setup npm script to fetch manual file feat(manfile): include manual file in packages MONGOSH-1017 Oct 28, 2021
@mabaasit mabaasit requested a review from addaleax October 29, 2021 13:34
tar.x({ cwd: destination })
);
await promisify(pipeline)(
createReadStream(join(destination, 'mongosh.1')),
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
createReadStream(join(destination, 'mongosh.1')),
createReadStream(join(destination, path.basename(name, '.gz'))),

@addaleax addaleax changed the title feat(manfile): include manual file in packages MONGOSH-1017 feat(build): include manual file in packages MONGOSH-1017 Nov 1, 2021
@mabaasit mabaasit merged commit 3507539 into main Nov 2, 2021
@mabaasit mabaasit deleted the MONGOSH-1017-manfile-in-tarball branch November 2, 2021 15:58
addaleax added a commit that referenced this pull request Nov 3, 2021
This implements the (optional) review comment in
#1144 (comment),
it’s nice to avoid hardcoding things that are also available
through the build config file.
addaleax added a commit that referenced this pull request Nov 24, 2021
* chore(build): avoid hardcoding manpage name

This implements the (optional) review comment in
#1144 (comment),
it’s nice to avoid hardcoding things that are also available
through the build config file.

* fixup: refactor rpm manpage inclusion code

* chore: add man page checks to test rpm/deb docker setups
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants