Merge pull request #8 from github/skarim/docs

Docs site for stacks

Author: skarim

.github/workflows/docs.yml

@@ -0,0 +1,59 @@
+name: Docs
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - '.github/workflows/docs.yml'
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages-${{ github.ref }}"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '24'
+          cache: 'npm'
+          cache-dependency-path: 'docs/package-lock.json'
+
+      - name: Install dependencies
+        working-directory: ./docs
+        run: npm ci --legacy-peer-deps
+
+      - name: Build documentation
+        working-directory: ./docs
+        run: npm run build
+
+      - name: Upload build artifacts
+        if: github.ref == 'refs/heads/main' || github.event_name == 'workflow_dispatch'
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs/dist
+
+  deploy:
+    if: github.ref == 'refs/heads/main' || github.event_name == 'workflow_dispatch'
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/release.yml

@@ -1,4 +1,4 @@
-name: release
+name: Release
 
 on:
   push:

CODEOWNERS

@@ -0,0 +1,2 @@
+# This repository is maintained by:
+* @skarim

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at <opensource@github.com>. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,96 @@
+## Contributing
+
+[fork]: https://github.com/github/gh-stack/fork
+[pr]: https://github.com/github/gh-stack/compare
+
+Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
+
+Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE).
+
+Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
+
+## Prerequisites
+
+- [Go](https://go.dev/doc/install) (version specified in `go.mod`)
+- [GitHub CLI](https://cli.github.com/) (`gh`) v2.0+
+
+## Local setup
+
+```sh
+# Clone the repository (or your fork)
+git clone https://github.com/github/gh-stack.git
+cd gh-stack
+
+# Download dependencies
+go mod download
+```
+
+## Build
+
+```sh
+go build ./...
+```
+
+This produces a `gh-stack` binary in the current directory.
+
+## Test
+
+```sh
+# Run all tests with race detection
+go test -race -count=1 ./...
+```
+
+## Vet
+
+```sh
+go vet ./...
+```
+
+## Install locally as a `gh` extension
+
+To test your local build as a `gh` CLI extension:
+
+```sh
+# Build the binary
+go build -o gh-stack .
+
+# Remove any existing installation
+gh extension remove stack
+
+# Install from the local directory
+gh extension install .
+```
+
+You can now run `gh stack` and it will use your locally built version.
+
+## Docs site
+
+The documentation site lives in `docs/` and uses [Astro](https://astro.build/) + [Starlight](https://starlight.astro.build/).
+
+```sh
+cd docs
+npm install
+npm run dev       # Start dev server at localhost:4321
+npm run build     # Production build to docs/dist/
+```
+
+## Submitting a pull request
+
+1. [Fork][fork] and clone the repository
+1. Create a new branch: `git checkout -b my-branch-name`
+1. Make your change and add tests
+1. Make sure tests pass: `go test -race -count=1 ./...`
+1. Make sure vet passes: `go vet ./...`
+1. Push to your fork and [submit a pull request][pr]
+
+Here are a few things you can do that will increase the likelihood of your pull request being accepted:
+
+- Write tests.
+- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
+- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+
+## Resources
+
+- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
+- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
+- [GitHub Help](https://help.github.com)

README.md

@@ -23,12 +23,10 @@ npx skills add github/gh-stack
 ## Quick start
 
 ```sh
-# Start a new stack from the default branch
+# Start a new stack (creates and checks out the first branch)
 gh stack init
 
-# Create the first branch and start working
-gh stack add auth-layer
-# ... make commits ...
+# ... make commits on the first branch ...
 
 # Add another branch on top
 gh stack add api-endpoints
@@ -224,7 +222,7 @@ gh stack rebase --upstack
 # After resolving a conflict
 gh stack rebase --continue
 
-# Give up and restore everything
+# Abort rebase and restore everything
 gh stack rebase --abort
 ```
 
@@ -378,12 +376,42 @@ gh stack feedback
 gh stack feedback "Support for reordering branches"
 ```
 
+### `gh stack alias`
+
+Create a short command alias so you can type less.
+
+```
+gh stack alias [name] [flags]
+```
+
+Installs a small wrapper script into `~/.local/bin/` that forwards all arguments to `gh stack`. The default alias name is `gs`, but you can choose any name by passing it as an argument. After setup, you can run `gs push` instead of `gh stack push`.
+
+On Windows, automatic alias creation is not supported — the command prints manual instructions for creating a batch file or PowerShell function.
+
+| Flag | Description |
+|------|-------------|
+| `--remove` | Remove a previously created alias |
+
+**Examples:**
+
+```sh
+# Create the default alias (gs)
+gh stack alias
+#    → now "gs push", "gs view", etc. all work
+
+# Create a custom alias
+gh stack alias gst
+
+# Remove an alias
+gh stack alias --remove
+gh stack alias gst --remove
+```
+
 ## Typical workflow
 
 ```sh
-# 1. Start a stack
+# 1. Start a stack (creates and checks out the first branch)
 gh stack init
-gh stack add auth-middleware
 
 # 2. Work on the first layer
 #    ... write code, make commits ...
@@ -461,3 +489,17 @@ Compared to the typical workflow, there's no need to name branches, run `git add
 | 6 | Disambiguation required (branch belongs to multiple stacks) |
 | 7 | Rebase already in progress |
 | 8 | Stack is locked by another process |
+
+## License 
+
+This project is licensed under the terms of the MIT open source license. Please refer to the [LICENSE](LICENSE) file for the full terms.
+
+## Maintainers 
+
+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.

SECURITY.md

@@ -0,0 +1,31 @@
+Thanks for helping make GitHub safe for everyone.
+
+# Security
+
+GitHub takes the security of our software products and services seriously, including all of the open source code repositories managed through our GitHub organizations, such as [GitHub](https://github.com/GitHub).
+
+Even though [open source repositories are outside of the scope of our bug bounty program](https://bounty.github.com/index.html#scope) and therefore not eligible for bounty rewards, we will ensure that your finding gets passed along to the appropriate maintainers for remediation. 
+
+## Reporting Security Issues
+
+If you believe you have found a security vulnerability in any GitHub-owned repository, please report it to us through coordinated disclosure.
+
+**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.**
+
+Instead, please send an email to opensource-security[@]github.com.
+
+Please include as much of the information listed below as you can to help us better understand and resolve the issue:
+
+  * The type of issue (e.g., buffer overflow, SQL injection, or cross-site scripting)
+  * Full paths of source file(s) related to the manifestation of the issue
+  * The location of the affected source code (tag/branch/commit or direct URL)
+  * Any special configuration required to reproduce the issue
+  * Step-by-step instructions to reproduce the issue
+  * Proof-of-concept or exploit code (if possible)
+  * Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+## Policy
+
+See [GitHub's Safe Harbor Policy](https://docs.github.com/en/site-policy/security-policies/github-bug-bounty-program-legal-safe-harbor#1-safe-harbor-terms)

SUPPORT.md

@@ -0,0 +1,15 @@
+# Support 
+
+## How to file issues and get help
+
+This project uses GitHub issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates. For new issues, file your bug or feature request as a new issue.
+
+For help or questions about using this project, please use GitHub Discussions. Add a comment to an existing post or create a new discussion post.
+
+**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.

docs/.gitignore

@@ -0,0 +1,22 @@
+# build output
+dist/
+
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+# environment variables
+.env
+.env.local
+.env.production
+
+# macOS-specific files
+.DS_Store