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.

Sign up for GitHub

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

Generate reference docs with all backends enabled #44

Merged
merged 2 commits into from
Jan 2, 2024
Merged

Generate reference docs with all backends enabled #44

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d57e976
Grab all backends
thejcannon Jan 2, 2024
0c45ea6
extra comma
thejcannon Jan 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .github/workflows/sync_docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,14 @@ jobs:
curl --proto '=https' --tlsv1.2 -fsSL https://static.pantsbuild.org/setup/get-pants.sh | bash
echo "$HOME/.local/bin" >> $GITHUB_PATH
- name: Generate help JSON
# Run the command twice, since the first run might put extraneous crap on stdout
# First run `help-all` which will contain the list of every backend in the `name_to_backend_help_info` object,
# then run it again with every backend enabled.
# NB: We run the command initially twice, since the first run might put extraneous crap on stdout.
Copy link
Contributor

Choose a reason for hiding this comment

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

Btw, is this something we can file a Pants bug about, since it's seems... unhelpful?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think it might be a scie-pants issue but haven't had time to dig in

Copy link
Member

Choose a reason for hiding this comment

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

I think this covers it: pantsbuild/pants#20315

run: |
touch pants.toml
PANTS_VERSION="${{ inputs.version }}" pants help-all > /dev/null
PANTS_VERSION="${{ inputs.version }}" pants help-all > help-all.json
PANTS_VERSION="${{ inputs.version }}" pants --backend-packages=[$(jq -r '.name_to_backend_help_info | keys_unsorted | map("\"" + . + "\"") | join(",")' help-all.json)] help-all > help-all.json

# Checkout both repos
- name: Checkout pants repo
Expand Down