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

Jump to bottom

Update code/docs referencing old docs processes #20435

Merged
merged 1 commit into from
Jan 17, 2024
Merged

Update code/docs referencing old docs processes #20435

merged 1 commit into from
Jan 17, 2024

Conversation

thejcannon
Copy link
Member

This change rips out old code/docs that were relevant to the old readme.com docs site, and replaces it with whatever is relevant with the new docs site (or just leaves the dead bits).

@thejcannon thejcannon added needs-cherrypick category:internal CI, fixes for not-yet-released features, etc. labels Jan 17, 2024
@thejcannon thejcannon added this to the 2.19.x milestone Jan 17, 2024
@thejcannon thejcannon requested review from kaos, benjyw and huonw January 17, 2024 19:30
thejcannon
thejcannon commented Jan 17, 2024
View reviewed changes
docs/docs/contributions/releases/release-process.mdx
@@ -97,33 +97,7 @@ $ git checkout -b 2.9.x
$ git push upstream 2.9.x
```

## Step 2: Update this docs site
Copy link
Member Author

Choose a reason for hiding this comment

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

In a separate PR I'll edit the release workflow to trigger a docs sync at the end of a release.

src/python/pants/bin/BUILD
@@ -9,7 +9,6 @@ python_sources(
dependencies=[":plugins"],
)

# NOTE: When adding a new backend, add it to `generate_docs.py` too! (If stable enough for docs)
Copy link
Member Author

Choose a reason for hiding this comment

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

Reminder that the new workflow just enables everything.

One less list to rememeber forget to add to!

@thejcannon
Copy link
Member Author

FYI @benjyw @huonw I marked as CP to 2.19.x, but obviously doesn't block release 😄

benjyw
benjyw approved these changes Jan 17, 2024
View reviewed changes
Copy link
Contributor

@benjyw benjyw left a comment

Choose a reason for hiding this comment

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

🎉

docs/docs/contributions/releases/release-process.mdx
@@ -151,7 +125,7 @@ Run this script as a basic smoke test:

You should also check [GitHub Releases](https://github.com/pantsbuild/pants/releases) to ensure everything looks good. Find the version you released, then click it and confirm that the "Assets" list includes PEXes for macOS and Linux.

## Step 5: Run release testing on public repositories
## Step 4: Run release testing on public repositories
Copy link
Contributor

Choose a reason for hiding this comment

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

I love the reduction in number of steps. Let's get that down to 1!!

Copy link
Member Author

Choose a reason for hiding this comment

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

You were saying? (Down to 4 steps 😛 )

huonw
huonw approved these changes Jan 17, 2024
View reviewed changes
Copy link
Contributor

@huonw huonw left a comment

Choose a reason for hiding this comment

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

Sweet!

@thejcannon thejcannon merged commit a10312d into main Jan 17, 2024
24 checks passed
@thejcannon thejcannon deleted the jcannon/update-docs branch January 17, 2024 23:55
@WorkerPants
Copy link
Member

I tried to automatically cherry-pick this change back to each relevant milestone, so that it is available in those older releases of Pants.

❌ 2.19.x

I was unable to cherry-pick this PR to 2.19.x, likely due to merge-conflicts.

Steps to Cherry-Pick locally

To resolve:

  1. (Ensure your git working directory is clean)
  2. Run the following script to reproduce the merge-conflicts: 
    git fetch https://github.com/pantsbuild/pants main \
  && git fetch https://github.com/pantsbuild/pants 2.19.x \
  && git checkout -b cherry-pick-20435-to-2.19.x FETCH_HEAD \
  && git cherry-pick a10312da576db757e703c6737497f085c90e5fe2
  3. Fix the merge conflicts and commit the changes
  4. Run build-support/cherry_pick/make_pr.sh "20435" "2.19.x"

Please note that I cannot re-run CI if a job fails. Please work with your PR approver(s) to re-run CI if necessary.

When you're done manually cherry-picking, please remove the needs-cherrypick label on this PR.

Thanks again for your contributions!

🤖 Beep Boop here's my run link

@WorkerPants WorkerPants added the auto-cherry-picking-failed Auto Cherry-Picking Failed label Jan 17, 2024
thejcannon added a commit that referenced this pull request Jan 19, 2024
@thejcannon
Update code/docs referencing old docs processes (#20435)
fc15d99 
This change rips out old code/docs that were relevant to the old
readme.com docs site, and replaces it with whatever is relevant with the
new docs site (or just leaves the dead bits).
kaos pushed a commit that referenced this pull request Jan 29, 2024
@thejcannon
Update code/docs referencing old docs processes (Cherry-pick of #20435)…
f7f0093 
… (#20439)

This change rips out old code/docs that were relevant to the old
readme.com docs site, and replaces it with whatever is relevant with the
new docs site (or just leaves the dead bits).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@benjyw benjyw benjyw approved these changes

@huonw huonw huonw approved these changes

@kaos kaos Awaiting requested review from kaos

Assignees
No one assigned
Labels
auto-cherry-picking-failed Auto Cherry-Picking Failed category:internal CI, fixes for not-yet-released features, etc.
Projects
None yet
Milestone
2.19.x
Development

Successfully merging this pull request may close these issues.
4 participants
@thejcannon @WorkerPants @benjyw @huonw