Skip to content

Commit

Permalink
Updata artifacthub-pkg.yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Nov 6, 2023
1 parent fc41496 commit 164bee6
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 0 deletions.
38 changes: 38 additions & 0 deletions semver/0.1.1/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## Introduction

Module `semvar` implements a comparison of semantic version strings.
In this module, semantic version strings must begin with a leading "v",
as in "v1.0.0".

The general form of a semantic version string accepted by this module is

vMAJOR[.MINOR[.PATCH[-PRERELEASE][+BUILD]]]

where square brackets indicate optional parts of the syntax;
MAJOR, MINOR, and PATCH are decimal integers without extra leading zeros;
PRERELEASE and BUILD are each a series of non-empty dot-separated identifiers
using only alphanumeric characters and hyphens; and
all-numeric PRERELEASE identifiers must not have leading zeros.

This module follows Semantic Versioning 2.0.0 (see semver.org)
with two exceptions. First, it requires the "v" prefix. Second, it recognizes
vMAJOR and vMAJOR.MINOR (with no prerelease or build suffixes)
as shorthands for vMAJOR.0.0 and vMAJOR.MINOR.0.

## How to Use

+ Add the dependency

```shell
kcl mod add semver
```

```python
import semver

valid_semver = semver.is_valid("v1.1.0") # True
```

## Resource

The code source and document are [here](https://github.com/kcl-lang/artifacthub/tree/main/semver)
26 changes: 26 additions & 0 deletions semver/0.1.1/artifacthub-pkg.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
version: 0.1.1
name: semver
displayName: semver
createdAt: "2023-11-06T09:45:05Z"
description: Module semver implements comparison of semantic version strings. In this
module, semantic version strings must begin with a leading `v`, as in `v1.0.0`.
links:
- name: KCL homepage
url: https://kcl-lang.io/
- name: KCL repo
url: https://github.com/kcl-lang/kcl
install: |
#### Add `semver` with tag `0.1.1` as dependency
```
kpm add semver:0.1.1
```
#### Pull `semver` with tag `0.1.1` to local
```
kpm pull semver:0.1.1
```
maintainers:
- name: kcl-lang.io
email: [email protected]
provider:
name: kcl-lang.io

0 comments on commit 164bee6

Please sign in to comment.