Skip to content

Commit

Permalink
Declare library as stable
Browse files Browse the repository at this point in the history
  • Loading branch information
aw committed Nov 16, 2020
1 parent aaef215 commit 8f7d259
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
strategy:
matrix:
arch: ['src', 'src64']
version: ['17.12', '18.6', '18.12', '19.6', '19.12', '20.6', 'latest']
version: ['17.12', '18.6', '18.12', '19.6', '19.12', '20.6', 'pil21', 'latest']

steps:
- uses: actions/checkout@v1
Expand Down
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Changelog

## 1.0.0 (2020-11-16)

* Declare library as **STABLE**: `v1.0`
* Test with pil21
* Update `picolisp-unit` dependency to `v3.1.0`

## 0.11.0 (2020-06-05)

* Fix regression in 'curl' uploads, where binary data wasn't uploaded correctly.
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ REPO_PREFIX ?= https://github.com/aw
# Unit testing
TEST_REPO = $(REPO_PREFIX)/picolisp-unit.git
TEST_DIR = $(PIL_MODULE_DIR)/picolisp-unit/HEAD
TEST_REF = v3.0.0
TEST_REF = v3.1.0

.PHONY: all

Expand Down
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This command line tool can be used to sign [AWS Signature Version 4](https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html) requests and make calls to various AWS APIs.

[![GitHub release](https://img.shields.io/github/release/aw/picolisp-awscurl.svg)](https://github.com/aw/picolisp-awscurl) [![Dependency](https://img.shields.io/badge/[deps] picolisp--unit-v3.0.0-ff69b4.svg)](https://github.com/aw/picolisp-unit.git) ![Build status](https://github.com/aw/picolisp-awscurl/workflows/CI/badge.svg?branch=master)
[![GitHub release](https://img.shields.io/github/release/aw/picolisp-awscurl.svg)](https://github.com/aw/picolisp-awscurl) [![Dependency](https://img.shields.io/badge/[deps] picolisp--unit-v3.1.0-ff69b4.svg)](https://github.com/aw/picolisp-unit.git) ![Build status](https://github.com/aw/picolisp-awscurl/workflows/CI/badge.svg?branch=master)

1. [Requirements](#requirements)
2. [Usage](#usage)
Expand All @@ -14,7 +14,7 @@ This command line tool can be used to sign [AWS Signature Version 4](https://doc

# Requirements

* `picolisp`: 32-bit or 64-bit `v3.1.11+`, tested up to PicoLisp `v20.6.29`, [see test runs](https://github.com/aw/picolisp-awscurl/actions/)
* `picolisp`: 32-bit or 64-bit `v3.1.11+`, tested up to PicoLisp `v20.6.29` and `pil21`, [see test runs](https://github.com/aw/picolisp-awscurl/actions/)
* `libcrypto.so`: for using `--native` functions with PicoLisp `v17.12+`
* `picolisp-unit`: `v3.0.0+` for testing the library
* `openssl`: `v1.0.0+` for signing and hashing strings
Expand All @@ -24,11 +24,15 @@ This command line tool can be used to sign [AWS Signature Version 4](https://doc

The file `libawscurl.l` can be included as a library, rather than using the command line `awscurl.l`. Function are prefixed with `awscurl-` and variables are prefixed with `*Aws_`.

### Stability

This library is now declared **stable** and should be suitable for use in production environments.

# Usage

## WARNING

There is currently **no validation** on command line arguments. Be careful the input you provide. [See issue #1](https://github.com/aw/picolisp-awscurl/issues/1)
There is **no validation** on command line arguments. Be careful the input you provide. [See issue #1](https://github.com/aw/picolisp-awscurl/issues/1)

### Environment variables

Expand Down
2 changes: 1 addition & 1 deletion awscurl.l
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[de APP_INFO
("name" "awscurl")
("version" "0.11.0")
("version" "1.0.0")
("summary" "PicoLisp AWS CLI tool using OpenSSL and Curl")
("source" "https://github.com/aw/picolisp-awscurl")
("author" "Alexander Williams")
Expand Down
4 changes: 2 additions & 2 deletions module.l
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[de MODULE_INFO
("name" "awscurl")
("version" "0.11.0")
("version" "1.0.0")
("summary" "PicoLisp AWS CLI tool using OpenSSL and Curl")
("source" "https://github.com/aw/picolisp-awscurl.git")
("author" "Alexander Williams")
("license" "MIT")
("copyright" "(c) 2018-2020 Alexander Williams, Unscramble <license@unscramble.jp>")
("install" "make")
("requires"
("picolisp-unit" "v3.0.0" "https://github.com/aw/picolisp-unit.git") ]
("picolisp-unit" "v3.1.0" "https://github.com/aw/picolisp-unit.git") ]

0 comments on commit 8f7d259

Please sign in to comment.