Skip to content

About

index registry for CCGO

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 

Repository files navigation

CCGO Package Index

The official Git-based package index used by CCGO.

  • Repository: git@github.com:zhlinh/ccgo-index.git
  • CCGO registry name: ccgo-index
  • Format version: 1

This repository stores package metadata. ZIP artifacts are hosted separately, for example in Maven repositories or GitHub Releases.

Layout

index.json contains the index metadata. Package JSON files are created by ccgo publish index using lowercase package names:

Name length Path Example
1 1/<name>.json 1/a.json
2 2/<name>.json 2/cc.json
3 3/<first>/<name>.json 3/f/fmt.json
4 or more <first-two>/<next-two>/<name>.json st/dc/stdcomm.json

Each package file records its repository, description, supported platforms and versions. Versions may include an archive_url, archive format and SHA-256 checksum for downloading an existing artifact. Without an archive URL, CCGO uses the package repository and version tag to fetch source code.

An empty index needs only index.json; package directories are created on the first publication. No server, database or build step is required.

Publish

Run from a package project containing CCGO.toml:

# Validate without uploading or changing this index.
ccgo publish index --registry official

# Publish a package version and push the index commit.
ccgo publish index --registry official --push

# Upload an existing ZIP to Maven and publish its URL/checksum in this index.
ccgo publish index --registry official \
  --artifact-provider maven --artifact-group com.example \
  --path ./SDK.zip --push

Publishing requires SSH authentication and write access to this repository. Maven storage uses CCGO_MAVEN_URL, CCGO_MAVEN_USERNAME and CCGO_MAVEN_PASSWORD. The current publisher also requires the selected source tag to exist locally, including when using an artifact provider. Published versions are append-only: use a new version instead of overwriting an entry.

Initial Setup

The local checkout already has its Git remote configured. Before other machines can clone and use this index, create and push its initial commit:

git add README.md index.json
git commit -m "chore: initialize CCGO package index"
git push -u origin main

The configured SSH URL requires GitHub SSH access for readers too. A public repository can also be accessed using its HTTPS URL when configured as a custom registry.

About

index registry for CCGO

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors