Skip to content

Automatically set the version in generate_docs.py#11337

Merged
Eric-Arellano merged 4 commits into
pantsbuild:masterfrom
Eric-Arellano:docs-version
Dec 18, 2020
Merged

Automatically set the version in generate_docs.py#11337
Eric-Arellano merged 4 commits into
pantsbuild:masterfrom
Eric-Arellano:docs-version

Conversation

@Eric-Arellano
Copy link
Copy Markdown
Contributor

We now have generated references for 2.0, 2.1, and 2.2. This change facilitates targeting the correct version.

[ci skip-rust]
[ci skip-build-wheels]

# Rust tests and lints will be skipped. Delete if not intended.
[ci skip-rust]

# Building wheels and fs_util will be skipped. Delete if not intended.
[ci skip-build-wheels]
@Eric-Arellano
Copy link
Copy Markdown
Contributor Author

I won't plan to cherry-pick into 2.0 and 2.1. We can temporarily change the hardcoded value in those branches.

Copy link
Copy Markdown
Member

@stuhood stuhood left a comment

Choose a reason for hiding this comment

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

Wouldn't this always have to be the current VERSION?

@Eric-Arellano
Copy link
Copy Markdown
Contributor Author

Wouldn't this always have to be the current VERSION?

Oh, true, we can approach this differently with an input() to make the user confirm this is the version they want to build for.

…adme

The empty string resulted in rendering `<code></code>`, which caused Readme to crash.

# Rust tests and lints will be skipped. Delete if not intended.
[ci skip-rust]

# Building wheels and fs_util will be skipped. Delete if not intended.
[ci skip-build-wheels]
@Eric-Arellano Eric-Arellano changed the title Parametrize the version in generate_docs.py Automatically set the version in generate_docs.py Dec 18, 2020
# Rust tests and lints will be skipped. Delete if not intended.
[ci skip-rust]

# Building wheels and fs_util will be skipped. Delete if not intended.
[ci skip-build-wheels]
advanced=True,
type=str,
default="",
default=DEFAULT_EXECUTION_OPTIONS.process_execution_cache_namespace,
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Presumably unrelated?

Copy link
Copy Markdown
Contributor Author

@Eric-Arellano Eric-Arellano Dec 18, 2020

Choose a reason for hiding this comment

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

Without this, the readme page for global options fails with a 500 error because there's an empty <code></code> block. Explained in 9398f64.

# Rust tests and lints will be skipped. Delete if not intended.
[ci skip-rust]

# Building wheels and fs_util will be skipped. Delete if not intended.
[ci skip-build-wheels]
@Eric-Arellano Eric-Arellano merged commit 0a6f08d into pantsbuild:master Dec 18, 2020
@Eric-Arellano Eric-Arellano deleted the docs-version branch December 18, 2020 20:24
@stuhood stuhood mentioned this pull request Dec 29, 2020
stuhood added a commit that referenced this pull request Dec 29, 2020
### Internal Changes

* Fix too many line breaks for options in docs site ([#11377](#11377))

* Use more newlines in options help messages ([#11372](#11372))

* Fix some newlines not rendering correctly on docsite ([#11371](#11371))

* Fix formatting for `./pants subsystems` and `./pants targets` ([#11368](#11368))

* Simplify `generate_docs.py` to no longer require manually generating the input data ([#11363](#11363))

* Use the whole description for `./pants help $subsystem` ([#11361](#11361))

* Use newlines in `./pants help $target_type` ([#11355](#11355))

* [internal] Install rustup on the lint shards. ([#11392](#11392))

* Install Rust through global, pre-installed Rustup ([#11256](#11256))

* Revert "Add goals to run_info (#11374)" ([#11379](#11379))

* Add goals to run_info ([#11374](#11374))

* Update all rust dependencies within their declared ranges. ([#11366](#11366))

* Update to nails 0.11.0. ([#11370](#11370))

* cleanup some futures-related references ([#11360](#11360))

* [internal] Switch to toolchain pants plugin ([#11357](#11357))

* Simplify and fix the @ensure_daemon decorator. ([#11356](#11356))

* restore some try_future uses that were recently removed ([#11353](#11353))

* remove all remaining uses of futures v0.1.x (in favor of v0.3.x) ([#11352](#11352))

* Prepare the 1.30.2 release notes. ([#11351](#11351))

* remove remaining futures v0.1.x uses from fs/store and downstream callers ([#11346](#11346))

* fix Prost revision that did not get updated in prior PR ([#11345](#11345))

* add extension method for prost::Message for encoding to Bytes ([#11344](#11344))

* Stop installing Cmake, Go, and Protoc when bootstrapping Rust ([#11336](#11336))

* Automatically set the version in generate_docs.py ([#11337](#11337))

* Prepare 2.1.1. ([#11334](#11334))

* Prepare 2.0.1. ([#11333](#11333))

* Prepare the 1.30.2rc3 release notes. ([#11327](#11327))

* Prepare 2.0.1rc4 (again). ([#11323](#11323))

* Add type annotations around Subsystem class ([#11389](#11389))

* Support deprecation_start_version in help info. ([#11350](#11350))

[ci skip-rust]
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.

3 participants