docs: prepare installer repository for public release - #5
Merged
Conversation
BartoszBlizniak
force-pushed
the
agent/public-repository-readiness
branch
from
July 15, 2026 16:32
5b8ba6f to
5324da0
Compare
BartoszBlizniak
force-pushed
the
agent/public-repository-readiness
branch
from
July 16, 2026 08:32
5324da0 to
c355d8e
Compare
BartoszBlizniak
marked this pull request as ready for review
July 16, 2026 08:43
There was a problem hiding this comment.
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.mdinto 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.ps1bytes 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.
|
|
||
| ## At a glance | ||
|
|
||
| | Capability | Behaviour | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
Validation
git diff --checkpassingCompatibility
No installer behavior or public interface changed. The approved
install.shandinstall.ps1files are unchanged byte-for-byte.The vendoring workflow now preserves those exact bytes and generates the metadata expected by each integration.
Checklist
CHANGELOG.mdwhere appropriate.