README


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

This package provides Alibaba Cloud API metadata as PHP array files,
generated from the original JSON metadata.

The documentation and examples have been stripped to optimize for SDK
generation and faster I/O loading. If you require the full version of
the metadata, please refer to the `acs-metadata-full` repository.

The PHP array files are pre-generated from the `acs-metadata-build`
repository, and the artifacts are hosted on Cloudflare R2. To update
metadata, set the bucket name in the `R2_BUCKET` environment variable and
specify the release tag with `TAG`, then run the Makefile target:

    R2_BUCKET=<your-bucket-name> TAG=<version> make deploy


Versioning
----------

This package follows the version format `MAJOR.MINOR.YYYYMMDD`.

The patch component uses a date instead of an incrementing number to
make the freshness of the metadata immediately visible.

- **Major** version increments indicate breaking changes to the metadata
  schema.
- **Minor** version increments indicate backward-compatible changes to
  the metadata schema.
- **Patch** version represents the metadata snapshot date in `YYYYMMDD`
  format and indicates when the metadata was generated from Alibaba
  Cloud.

Consumers should depend on `^MAJOR.MINOR`, for example:

    "lizhineng/afterglow-metadata": "^1.0"