Skip to content

Commit

Permalink
prepare final release 1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
llaville committed Nov 9, 2021
1 parent e77f949 commit 7f5324f
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 2 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,6 @@ using the [Keep a CHANGELOG](http://keepachangelog.com) principles.

## [Unreleased]

## [1.0.0] - 2021-11-09

Implements full [SARIF specifications 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html)
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,19 @@ It is a powerful and sophisticated format suited to the needs of a wide variety
## Specifications

The specification document for the Static Analysis Results Interchange Format (SARIF) version 2.1.0, in HTML format
is available [here](http://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html).
is available [here](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html).

## View and validate your SARIF files

- [Upload and explore your SARIF file](https://sarifweb.azurewebsites.net/Validation)

## Documentation

All the documentation is available on [website](https://llaville.github.io/sarif-php-sdk),
generated from the [docs](https://github.com/llaville/sarif-php-sdk/tree/master/docs) folder.

- [Getting Started](https://llaville.github.io/sarif-php-sdk/getting-started/).
- API [Reference](https://llaville.github.io/sarif-php-sdk/reference/address/) describes all SARIF objects with examples.

And also
- [Study the tutorials](https://github.com/microsoft/sarif-tutorials) from GitHub's Microsoft account.
7 changes: 6 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1 +1,6 @@
WIP
# What is the SARIF PHP SDK ?

This PHP SDK produces the SARIF output, which is a JSON file formatted
in accordance with the latest [specification](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html).
This implementation follows the general format rules but also specifies several custom properties
written in [property bags](https://docs.oasis-open.org/sarif/sarif/v2.1.0/os/sarif-v2.1.0-os.html#_Toc34317448).

0 comments on commit 7f5324f

Please sign in to comment.