Skip to content

Commit

Permalink
prepare env for major version 2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
llaville committed Jul 1, 2024
1 parent cd7f85e commit b6fe50f
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 6 deletions.
8 changes: 8 additions & 0 deletions .changes/2.x/header.tpl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<!-- markdownlint-disable MD013 MD024 -->
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
and is generated by [Changie](https://github.com/miniscruff/changie).
Empty file.
2 changes: 1 addition & 1 deletion .changie.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
changesDir: .changes/1.x
changesDir: .changes/2.x
unreleasedDir: unreleased
headerPath: header.tpl.md
changelogPath: CHANGELOG.md
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ on:
push:
branches:
- master
- "1.5"
- "2.0"
paths:
- docs/**
pull_request:
Expand All @@ -15,6 +15,6 @@ jobs:
deploy:
uses: llaville/.github/.github/workflows/gh-pages.yml@master
with:
destination-dir: "1.5"
destination-dir: "2.0"
force-orphan: false
hook-script: "resources/gh-pages-hook.sh"
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ jobs:
with: # https://github.com/softprops/action-gh-release#-customizing
prerelease: false
draft: false
body_path: ${{ github.workspace }}/.changes/1.x/${{ github.ref_name }}.md
body_path: ${{ github.workspace }}/.changes/2.x/${{ github.ref_name }}.md
# https://github.com/softprops/action-gh-release#%EF%B8%8F-uploading-release-assets
files: |
${{ github.workspace }}/sarif-php-sdk.phar
Expand Down
File renamed without changes.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
| Stable v1.3.x | [![Branch 1.3][Branch_103x-img]][Branch_103x] | [![Minimum PHP Version)][PHPVersion_103x-img]][PHPVersion_103x] | [![Stable Version 1.3][Packagist_103x-img]][Packagist_103x] | [![License 1.3][License_103x-img]][License_103x] | [![Documentation 1.3][Documentation_103x-img]][Documentation_103x] |
| Stable v1.4.x | [![Branch 1.4][Branch_104x-img]][Branch_104x] | [![Minimum PHP Version)][PHPVersion_104x-img]][PHPVersion_104x] | [![Stable Version 1.4][Packagist_104x-img]][Packagist_104x] | [![License 1.4][License_104x-img]][License_104x] | [![Documentation 1.4][Documentation_104x-img]][Documentation_104x] |
| Stable v1.5.x | [![Branch 1.5][Branch_105x-img]][Branch_105x] | [![Minimum PHP Version)][PHPVersion_105x-img]][PHPVersion_105x] | [![Stable Version 1.5][Packagist_105x-img]][Packagist_105x] | [![License 1.5][License_105x-img]][License_105x] | [![Documentation 1.5][Documentation_105x-img]][Documentation_105x] |
| Stable v2.0.x | [![Branch 2.0][Branch_200x-img]][Branch_200x] | [![Minimum PHP Version)][PHPVersion_200x-img]][PHPVersion_200x] | [![Stable Version 2.0][Packagist_200x-img]][Packagist_200x] | [![License 2.0][License_200x-img]][License_200x] | [![Documentation 2.0][Documentation_200x-img]][Documentation_200x] |

[Branch_100x-img]: https://img.shields.io/badge/branch-1.0-orange
[Branch_100x]: https://github.com/llaville/sarif-php-sdk/tree/1.0
Expand Down Expand Up @@ -79,6 +80,17 @@
[Documentation_105x-img]: https://img.shields.io/badge/documentation-v1.5-green
[Documentation_105x]: https://github.com/llaville/sarif-php-sdk/tree/1.5/docs

[Branch_200x-img]: https://img.shields.io/badge/branch-2.0-orange
[Branch_200x]: https://github.com/llaville/sarif-php-sdk/tree/2.0
[PHPVersion_200x-img]: https://img.shields.io/packagist/php-v/bartlett/sarif-php-sdk/2.0.0
[PHPVersion_200x]: https://www.php.net/supported-versions.php
[Packagist_200x-img]: https://img.shields.io/badge/packagist-v2.0.0-blue
[Packagist_200x]: https://packagist.org/packages/bartlett/sarif-php-sdk
[License_200x-img]: https://img.shields.io/packagist/l/bartlett/sarif-php-sdk
[License_200x]: https://github.com/llaville/sarif-php-sdk/blob/2.0/LICENSE
[Documentation_200x-img]: https://img.shields.io/badge/documentation-v2.0-green
[Documentation_200x]: https://github.com/llaville/sarif-php-sdk/tree/2.0/docs

## Introduction

SARIF, the Static Analysis Results Interchange Format, defines a standard format for the output of static analysis tools.
Expand All @@ -95,8 +107,8 @@ is available [here][sarif-specs].

## Documentation

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

- API [Reference](docs/reference/README.md) describes all SARIF objects with examples.

Expand Down

0 comments on commit b6fe50f

Please sign in to comment.