Skip to content

docs: prepare installer repository for public release - #5

Merged
BartoszBlizniak merged 1 commit into
mainfrom
agent/public-repository-readiness
Jul 16, 2026
Merged

docs: prepare installer repository for public release#5
BartoszBlizniak merged 1 commit into
mainfrom
agent/public-repository-readiness

Conversation

@BartoszBlizniak

@BartoszBlizniak BartoszBlizniak commented Jul 15, 2026

Copy link
Copy Markdown
Member

Summary

Prepares the Cloudsmith CLI installer repository for public release and makes the distribution path safer and easier to maintain.

The documentation now presents supported platforms, installer requirements, stable output, security guarantees, support channels, and compatibility expectations in a clear, GitHub-native layout. Public links have been checked, including the Cloudsmith support request form. The release workflow also vendors the approved installer bytes to the correct GitHub Actions, CircleCI, and Azure DevOps locations, with consumer-specific version and checksum metadata.

Type of change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Refactoring
  • Other (please describe)

Validation

  • Bats: 41/41 passing
  • POSIX shell syntax and ShellCheck passing
  • PowerShell AST parsing passing
  • Pester: 26 Windows-only tests discovered
  • Workflow YAML and embedded shell validation passing
  • Zizmor: no findings
  • Vendoring simulated successfully against all three integration layouts
  • GitHub Markdown rendering passing
  • Markdownlint: zero errors
  • README anchors, local paths, and public links checked
  • git diff --check passing

Compatibility

No installer behavior or public interface changed. The approved install.sh and install.ps1 files are unchanged byte-for-byte.

The vendoring workflow now preserves those exact bytes and generates the metadata expected by each integration.

Checklist

  • I have added or updated tests where appropriate.
  • I have updated documentation and CHANGELOG.md where appropriate.
  • I have not included credentials, tokens, or other sensitive data.
  • I have called out any breaking change explicitly.

@BartoszBlizniak
BartoszBlizniak force-pushed the agent/public-repository-readiness branch from 5b8ba6f to 5324da0 Compare July 15, 2026 16:32
@BartoszBlizniak
BartoszBlizniak force-pushed the agent/public-repository-readiness branch from 5324da0 to c355d8e Compare July 16, 2026 08:32
@BartoszBlizniak
BartoszBlizniak marked this pull request as ready for review July 16, 2026 08:43
Copilot AI review requested due to automatic review settings July 16, 2026 08:43
@BartoszBlizniak
BartoszBlizniak merged commit 1615a4c into main Jul 16, 2026
12 checks passed

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Prepares the Cloudsmith CLI installer repository for public release by expanding/standardizing the repo’s public-facing documentation and tightening the release vendoring workflow so downstream integrations receive exact, versioned installer bytes plus metadata.

Changes:

  • Reworked README.md into a GitHub-native, public-facing layout (quick start, requirements, configuration, output contract, supported targets, security, support).
  • Added new public docs for contribution, support, and security reporting (CONTRIBUTING.md, SUPPORT.md, SECURITY.md) and refined templates/changelog accordingly.
  • Updated the release workflow to vendor the exact install.sh/install.ps1 bytes into GitHub Actions / CircleCI / Azure DevOps integration layouts and verify the vendored outputs.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
tests/README.md Clarifies test-suite requirements and network-free fixture behavior.
SUPPORT.md Adds clear support routing for bugs, questions, CLI issues, and private support.
SECURITY.md Adds a public security policy and private reporting instructions.
README.md Major public-facing documentation restructure and compatibility/security/support details.
CONTRIBUTING.md Adds contribution workflow and explicit compatibility expectations.
CHANGELOG.md Improves release notes content for the initial release entry.
.github/workflows/release.yml Vendors exact release assets into downstream integrations and verifies vendored outputs.
.github/PULL_REQUEST_TEMPLATE.md Updates PR template to capture validation and compatibility impact.
.github/ISSUE_TEMPLATE/config.yml Updates the support contact link to the current support request form.
.github/ISSUE_TEMPLATE/bug_report.md Expands bug report template to capture requested CLI version and better context.
.github/CODEOWNERS Removes an individual owner entry, leaving the team as owner.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md

## At a glance

| Capability | Behaviour |
@BartoszBlizniak
BartoszBlizniak deleted the agent/public-repository-readiness branch July 16, 2026 10:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants