Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 0 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ A GitHub CLI extension for managing stacked branches and pull requests.

Stacked PRs break large changes into a chain of small, reviewable pull requests that build on each other. `gh stack` automates the tedious parts — creating branches, keeping them rebased, setting correct PR base branches, and navigating between layers.

> [!NOTE]
> Stacked PRs is currently in private preview. This CLI and the referenced functionality will not work unless the feature has been enabled for your repository.
> You can sign up for the waitlist at [gh.io/stacksbeta](https://gh.io/stacksbeta).

## Installation

```sh
Expand Down Expand Up @@ -722,5 +718,3 @@ See [CODEOWNERS](CODEOWNERS)
## Support

See [SUPPORT.md](SUPPORT.md)

Please note that the Stacked PRs feature is currently in private preview and **gh-stack** will not work without that feature enabled.
2 changes: 0 additions & 2 deletions SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ For help or questions about using this project, please use GitHub Discussions. A

**gh-stack** is under active development and maintained by GitHub staff. We will do our best to respond to support, feature requests, and community questions in a timely manner.

Please note that the Stacked PRs feature is currently in private preview and **gh-stack** will not work without that feature enabled.

## GitHub Support Policy

Support for this project is limited to the resources listed above.
12 changes: 2 additions & 10 deletions docs/src/content.config.ts
Original file line number Diff line number Diff line change
@@ -1,18 +1,10 @@
import { defineCollection, z } from 'astro:content';
import { defineCollection } from 'astro:content';
import { docsLoader } from '@astrojs/starlight/loaders';
import { docsSchema } from '@astrojs/starlight/schema';

export const collections = {
docs: defineCollection({
loader: docsLoader(),
schema: docsSchema({
extend: z.object({
banner: z.object({
content: z.string(),
}).default({
content: 'Stacked PRs is currently in private preview. <a href="https://gh.io/stacksbeta">Sign up for the waitlist →</a>',
}),
}),
}),
schema: docsSchema(),
}),
};
4 changes: 0 additions & 4 deletions docs/src/content/docs/getting-started/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,6 @@ description: Install the gh stack CLI and create your first Stacked PR in minute
- Git 2.20 or later
- A GitHub repository you can push to

:::caution[Private Preview]
Stacked PRs is currently in private preview. This feature will **not work** unless enabled for your repository. [Sign up for the waitlist →](https://gh.io/stacksbeta)
:::

## Install the CLI Extension

```sh
Expand Down
6 changes: 1 addition & 5 deletions docs/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ hero:
icon: right-arrow
---

import { Card, CardGrid, Aside } from '@astrojs/starlight/components';
import { Card, CardGrid } from '@astrojs/starlight/components';
import { Image } from 'astro:assets';
import StackDiagram from '../../components/StackDiagram.astro';
import stackNavigator from '../../assets/screenshots/stack-navigator.png';
Expand Down Expand Up @@ -59,10 +59,6 @@ When you're ready to merge, click **Merge** on the highest PR you want to land

## Get Started

<Aside type="caution" title="Private Preview">
Stacked PRs is currently in private preview. This feature will **not work** unless enabled for your repository. [Sign up for the waitlist →](https://gh.io/stacksbeta)
</Aside>

```sh
# Install the CLI extension
gh extension install github/gh-stack
Expand Down
4 changes: 0 additions & 4 deletions docs/src/content/docs/reference/rest-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ GitHub exposes stacks through the REST API in two ways:
1. **A `stack` object on pull request resources** — every pull request returned by the REST API carries a `stack` object describing its stack membership when it belongs to one.
2. **A dedicated Stacks API** — endpoints to list, read, create, extend, and dissolve stacks directly.

:::caution[Private Preview]
Stacked PRs is currently in private preview. These endpoints are only available for repositories where the feature is enabled. [Sign up for the waitlist →](https://gh.io/stacksbeta)
:::

## The `stack` object on Pull Requests

When a pull request belongs to a stack, GitHub includes a `stack` object on the pull request resource. This lets you read a PR's stack membership — the stack it belongs to, its size, and this PR's position within it — directly from the pull request, without a separate lookup.
Expand Down
Loading