git-markdown 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6f33ac1c14b49e3a3d5231ce443a450ec7344f18b02ef42f049c17e49208c66
-  data.tar.gz: b09d35e480bf309b409429dcee18bd83ba87aa661457e1977fd758a6dc7ba27b
+  metadata.gz: 172e6b2a862c275377ab3b381c6d6fd7496be5a5c2ddc1991078bf4efbb1d4d1
+  data.tar.gz: ef5d3662ba88f33464d469f3706bfefa76030fd81987ca468009ebeca1af21fc
 SHA512:
-  metadata.gz: 904ee7934acdb653cea60230b40b556bd414bdf3fc2fe7ce993a56052a26785b9d447ef8bf9030bc36ec38f9265db8ff88a34604241463f04060b447f4b68460
-  data.tar.gz: 78160afe20fa834dbda22a4cd4f5436f4e84d52e6774f0e03f12e63056e1a722bff0d5f1a84eafb25128c4aa4d526b400be1c2419f8a644767c31293a62f3724
+  metadata.gz: 7c0654a4c46623b667a3e43cb1171f0db5412b8686cd43678af7f13442b2dea846b34da4511caf822e37eff990a8565122c4aa9e53f9161683c350e523563199
+  data.tar.gz: dfb4863bda9623794d2e44bffd7dd3faed55590d13ea66c500ef0a62cbff3a8068739fbdb176e77962333362315dddc28a1f70d11a67396fac70d0b43df9dd1e

data/CHANGELOG.md

@@ -5,6 +5,28 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.0] - 2026-11-08
+
+
+### Changed
+
+- keep checks local and adopt Gemkit 0.3.1
+
+- keep checks local and adopt Gemkit 0.3.1 ([#17](https://github.com/ethos-link/git-markdown/pull/17))
+
+
+
+
+### Documentation
+
+- make Ethos Link the canonical documentation home
+
+- keep audited technical guidance alongside the code
+
+- add canonical documentation and branded social preview ([#18](https://github.com/ethos-link/git-markdown/pull/18))
+
+
+
 ## [0.2.1] - 2026-11-05
 
 

data/README.md

@@ -1,10 +1,16 @@
 # git-markdown
 
 [![Gem Version](https://badge.fury.io/rb/git-markdown.svg)](https://badge.fury.io/rb/git-markdown)
-[![Ruby](https://github.com/ethos-link/git-markdown/actions/workflows/ruby.yml/badge.svg)](https://github.com/ethos-link/git-markdown/actions/workflows/ruby.yml)
+[![Commit messages](https://github.com/ethos-link/git-markdown/actions/workflows/commitlint.yml/badge.svg)](https://github.com/ethos-link/git-markdown/actions/workflows/commitlint.yml)
 
 Convert GitHub pull requests into a single Markdown file you can review locally. Useful for offline or local AI review workflows with tools like [opencode](https://opencode.ai), GitHub Copilot CLI, and your own scripts.
 
+## Documentation
+
+This README and the linked repository guides describe the checked-out code.
+The [Ethos Link project page](https://www.ethos-link.com/opensource/git-markdown)
+provides the canonical public project guide, overview and resources.
+
 ## Features
 
 - Reuse existing GitHub credentials.
@@ -12,6 +18,12 @@ Convert GitHub pull requests into a single Markdown file you can review locally.
 - Filter threads by status and write to a file or stdout.
 - Use GitHub Enterprise and local credential storage with restricted permissions.
 
+## Requirements
+
+- Ruby 4.0+
+- Git (for remote detection)
+- GitHub credentials with access to the requested repository; classic tokens need `repo` scope for private repositories
+
 ## Install
 
 ```bash
@@ -40,7 +52,10 @@ Or specify the repo:
 git-markdown pr owner/repo#123
 ```
 
-It saves `PR-{number}-{title}.md` in the current directory by default.
+It saves `PR-{number}-{title-slug}.md` in the current directory by default.
+For a PR titled "Fix timeout handling", the filename is
+`PR-123-fix-timeout-handling.md`. The title slug is lowercased and replaces
+non-alphanumeric sequences with hyphens.
 
 ## Usage
 
@@ -54,7 +69,8 @@ git-markdown pr owner/repo#123
 # Output to stdout (useful for piping)
 git-markdown pr 123 --stdout | pbcopy  # macOS; on Linux use `xclip`/`wl-copy` or redirect to a file
 
-# Save to a directory
+# Save to an existing directory
+mkdir -p reviews
 git-markdown pr 123 --output ./reviews/
 
 # Filter comment threads (default: unresolved)
@@ -82,15 +98,25 @@ If you see a prompt for a GitHub username or an askpass error, set `GITHUB_TOKEN
 
 ## GitHub Enterprise
 
-Set your API URL:
+Set both API URLs. The REST API fetches PR content; GraphQL supplies review-thread resolution states:
 
 ```bash
 export GITHUB_API_URL=https://github.yourcompany.com/api/v3
+export GITHUB_GRAPHQL_URL=https://github.yourcompany.com/api/graphql
 git-markdown pr owner/repo#123
 ```
 
+Provide an Enterprise token through `GITHUB_TOKEN` or `GH_TOKEN`. The current
+Git credential lookup targets `github.com`, and `gh auth token` is invoked
+without an Enterprise hostname. Environment URLs fill unset configuration;
+values already saved in `config.yml` take precedence.
+
 ## Output
 
+The export contains PR metadata, descriptions and discussions. It does not
+include the code diff. Select comment filtering with `--status`; the CLI's
+current default is `unresolved`.
+
 The generated Markdown includes:
 
 - PR metadata (title, author, status, created date)
@@ -103,17 +129,11 @@ Threads marked with `[resolved]` or `[done]` are filtered out by default. Use `-
 
 ## Configuration
 
-Config is stored under `~/.config/git-markdown/`:
+Config is stored under `$XDG_CONFIG_HOME/git-markdown/`, or `~/.config/git-markdown/` when `XDG_CONFIG_HOME` is unset:
 
-- `config.yml` for settings (provider, API URL, defaults)
+- `config.yml` for provider, REST API URL and GraphQL URL settings
 - `credentials` for the token (permissions: 0600)
 
-## Requirements
-
-- Ruby 4.0+
-- Git (for remote detection)
-- GitHub Personal Access Token with `repo` scope
-
 ## Contributing
 
 1. Fork it
@@ -156,3 +176,15 @@ bundle exec rake verify
 
 Release preparation, publication, registry setup and recovery are documented
 in the [Gemkit release guide](https://github.com/ethos-link/ethos-gemkit#releasing-a-gem).
+
+## About Ethos Link
+
+[Ethos Link](https://www.ethos-link.com) is a software company founded by
+[Paulo Fidalgo](https://www.fidalgo.pt). This gem is part of the open-source
+tooling we publish alongside our business products:
+
+- [Reviato](https://www.reviato.com): collect private customer feedback and analyse public reviews.
+- [Nuntio](https://www.nuntiohq.com): prepare, review and schedule social posts.
+- [EthosPlaces](https://www.ethos.place): find places, opening hours and contact details.
+
+Explore our [open-source projects](https://www.ethos-link.com/opensource).

data/UPGRADE.md

@@ -1,10 +1,13 @@
 # Upgrade Guide
 
+Run `bundle exec rake verify` locally before pushing or preparing a release.
+GitHub Actions runs commitlint and release packaging/publication only.
+
 ## 0.2.0
 
 ### Shared development and release tooling
 
-Use Ruby 4 and published Gemkit 0.3.0. Install the bundle and hooks, then run the
+Use Ruby 4 and published Gemkit 0.3.1. Install the bundle and hooks, then run the
 project's verification command from the README. Prepare releases from clean,
 current main; merging the generated release PR publishes through Actions.
 See the [Gemkit upgrade guide](https://github.com/ethos-link/ethos-gemkit/blob/main/UPGRADE.md)

data/lib/git/markdown/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GitMarkdown
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-markdown
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Paulo Fidalgo
@@ -66,8 +66,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: A CLI tool that fetches GitHub pull requests and converts them to Markdown
-  format, perfect for local AI assistants like opencode and codex.
+description: A CLI tool that exports GitHub pull requests, review threads and discussion
+  comments to Markdown for local review.
 email:
 - devel@ethos-link.com
 executables:
@@ -104,7 +104,7 @@ metadata:
   source_code_uri: https://github.com/ethos-link/git-markdown
   bug_tracker_uri: https://github.com/ethos-link/git-markdown/issues
   changelog_uri: https://github.com/ethos-link/git-markdown/blob/main/CHANGELOG.md
-  documentation_uri: https://github.com/ethos-link/git-markdown/blob/main/README.md
+  documentation_uri: https://www.ethos-link.com/opensource/git-markdown
   funding_uri: https://www.reviato.com/
   github_repo: ssh://github.com/ethos-link/git-markdown
   allowed_push_host: https://rubygems.org