Skip to content

Commit 7c861af

Browse files
committed
:octocat: v5.0.x branch adjustments
1 parent a301af5 commit 7c861af

24 files changed

+50
-263
lines changed

.github/FUNDING.yml

Lines changed: 0 additions & 2 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 51 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 0 additions & 5 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/documentation.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 33 deletions
This file was deleted.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

.github/workflows/ci.yml

Lines changed: 2 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
on:
55
push:
66
branches:
7-
- main
7+
- v5.0.x
88
pull_request:
99
branches:
10-
- main
10+
- v5.0.x
1111

1212
name: "Continuous Integration"
1313

@@ -96,68 +96,3 @@ jobs:
9696
with:
9797
project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
9898
coverage-reports: .build/coverage/clover.xml
99-
100-
101-
build-docs:
102-
name: "Build and publish API docs"
103-
if: github.ref_name == 'main'
104-
runs-on: ubuntu-latest
105-
106-
steps:
107-
- name: "Checkout sources"
108-
uses: actions/checkout@v3
109-
110-
- name: "Install PHP"
111-
uses: shivammathur/setup-php@v2
112-
with:
113-
php-version: "8.1"
114-
coverage: none
115-
tools: phpDocumentor
116-
extensions: fileinfo, gd, imagick, json, mbstring
117-
118-
- name: "Build API docs"
119-
run: phpdoc --config=phpdoc.xml.dist
120-
121-
- name: "Publish API docs to branch gh-pages"
122-
uses: JamesIves/github-pages-deploy-action@v4
123-
with:
124-
branch: gh-pages
125-
folder: .build/phpdocs
126-
clean: true
127-
128-
129-
build-manual:
130-
name: "Build and publish user manual"
131-
if: github.ref_name == 'main'
132-
runs-on: ubuntu-latest
133-
134-
steps:
135-
- name: "Checkout sources"
136-
uses: actions/checkout@v3
137-
138-
- name: "Install PHP"
139-
uses: shivammathur/setup-php@v2
140-
with:
141-
php-version: "8.1"
142-
coverage: none
143-
144-
- name: "Install Sphinx"
145-
run: pip install sphinx myst-parser sphinx-rtd-theme
146-
147-
- name: "Install dependencies with composer"
148-
uses: ramsey/composer-install@v2
149-
150-
- name: "Build QROptions doc"
151-
run: php docs/qroptions-doc.php
152-
153-
- name: "Build manual"
154-
run: |
155-
cd docs
156-
make html
157-
158-
- name: "Publish user manual to branch readthedocs"
159-
uses: JamesIves/github-pages-deploy-action@v4
160-
with:
161-
branch: readthedocs
162-
folder: .build/sphinx/html
163-
clean: true

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,16 @@ It also features a QR Code reader based on a [PHP port](https://github.com/khana
1717
[php]: https://www.php.net/supported-versions.php
1818
[packagist-badge]: https://img.shields.io/packagist/v/chillerlan/php-qrcode.svg?logo=packagist
1919
[packagist]: https://packagist.org/packages/chillerlan/php-qrcode
20-
[gh-action-badge]: https://img.shields.io/github/actions/workflow/status/chillerlan/php-qrcode/ci.yml?branch=main&logo=github
20+
[gh-action-badge]: https://img.shields.io/github/actions/workflow/status/chillerlan/php-qrcode/ci.yml?branch=v5.0.x&logo=github
2121
[gh-action]: https://github.com/chillerlan/php-qrcode/actions/workflows/ci.yml?query=branch%3Amain
22-
[coverage-badge]: https://img.shields.io/codecov/c/github/chillerlan/php-qrcode/main?logo=codecov
23-
[coverage]: https://app.codecov.io/gh/chillerlan/php-qrcode/tree/main
24-
[codacy-badge]: https://img.shields.io/codacy/grade/edccfc4fe5a34b74b1c53ee03f097b8d/main?logo=codacy
25-
[codacy]: https://app.codacy.com/gh/chillerlan/php-qrcode/dashboard?branch=main
22+
[coverage-badge]: https://img.shields.io/codecov/c/github/chillerlan/php-qrcode/v5.0.x?logo=codecov
23+
[coverage]: https://app.codecov.io/gh/chillerlan/php-qrcode/tree/v5.0.x
24+
[codacy-badge]: https://img.shields.io/codacy/grade/edccfc4fe5a34b74b1c53ee03f097b8d/v5.0.x?logo=codacy
25+
[codacy]: https://app.codacy.com/gh/chillerlan/php-qrcode/dashboard?branch=v5.0.x
2626
[downloads-badge]: https://img.shields.io/packagist/dt/chillerlan/php-qrcode?logo=packagist
2727
[downloads]: https://packagist.org/packages/chillerlan/php-qrcode/stats
28-
[readthedocs-badge]: https://img.shields.io/readthedocs/php-qrcode/main?logo=readthedocs
29-
[readthedocs]: https://php-qrcode.readthedocs.io/en/main/
28+
[readthedocs-badge]: https://img.shields.io/readthedocs/php-qrcode/v5.0.x?logo=readthedocs
29+
[readthedocs]: https://php-qrcode.readthedocs.io/en/v5.0.x/
3030

3131
## Overview
3232

@@ -66,14 +66,14 @@ For the QRCode reader, either `ext-gd` or `ext-imagick` is required!
6666

6767
## Documentation
6868

69-
- The user manual is at https://php-qrcode.readthedocs.io/ ([sources](https://github.com/chillerlan/php-qrcode/tree/main/docs))
69+
- The user manual is at https://php-qrcode.readthedocs.io/ ([sources](https://github.com/chillerlan/php-qrcode/tree/v5.0.x/docs))
7070
- An API documentation created with [phpDocumentor](https://www.phpdoc.org/) can be found at https://chillerlan.github.io/php-qrcode/
7171
- The documentation for the `QROptions` container can be found here: [chillerlan/php-settings-container](https://github.com/chillerlan/php-settings-container#readme)
7272

7373

7474
## Installation with [composer](https://getcomposer.org)
7575

76-
See [the installation guide](https://php-qrcode.readthedocs.io/en/main/Usage-Installation.html) for more info!
76+
See [the installation guide](https://php-qrcode.readthedocs.io/en/v5.0.x/Usage-Installation.html) for more info!
7777

7878

7979
### Terminal
@@ -89,12 +89,12 @@ composer require chillerlan/php-qrcode
8989
{
9090
"require": {
9191
"php": "^7.4 || ^8.0",
92-
"chillerlan/php-qrcode": "dev-main#<commit_hash>"
92+
"chillerlan/php-qrcode": "v5.0.x-dev#<commit_hash>"
9393
}
9494
}
9595
```
9696

97-
Note: replace `dev-main` with a [version constraint](https://getcomposer.org/doc/articles/versions.md#writing-version-constraints), e.g. `^4.3` - see [releases](https://github.com/chillerlan/php-qrcode/releases) for valid versions.
97+
Note: replace `v5.0.x-dev` with a [version constraint](https://getcomposer.org/doc/articles/versions.md#writing-version-constraints), e.g. `^4.3` - see [releases](https://github.com/chillerlan/php-qrcode/releases) for valid versions.
9898

9999

100100
## Quickstart
@@ -108,11 +108,11 @@ $data = 'otpauth://totp/test?secret=B3JX4VCVJDVNXNZ5&issuer=chillerlan.net';
108108
echo '<img src="'.(new QRCode)->render($data).'" alt="QR Code" />';
109109
```
110110

111-
Wait, what was that? Please again, slower! See [Advanced usage](https://php-qrcode.readthedocs.io/en/main/Usage/Advanced-usage.html) in the manual.
112-
Also, have a look [in the examples folder](https://github.com/chillerlan/php-qrcode/tree/main/examples) for some more usage examples.
111+
Wait, what was that? Please again, slower! See [Advanced usage](https://php-qrcode.readthedocs.io/en/v5.0.x/Usage/Advanced-usage.html) in the manual.
112+
Also, have a look [in the examples folder](https://github.com/chillerlan/php-qrcode/tree/v5.0.x/examples) for some more usage examples.
113113

114114
<p align="center">
115-
<img alt="QR codes are awesome!" style="width: auto; height: 530px;" src="https://raw.githubusercontent.com/chillerlan/php-qrcode/main/.github/images/example.svg">
115+
<img alt="QR codes are awesome!" style="width: auto; height: 530px;" src="https://raw.githubusercontent.com/chillerlan/php-qrcode/v5.0.x/.github/images/example.svg">
116116
</p>
117117

118118

@@ -143,7 +143,7 @@ catch(Throwable $e){
143143
Hi, please check out some of my other projects that are way cooler than qrcodes!
144144

145145
- [js-qrcode](https://github.com/chillerlan/js-qrcode) - a javascript port of this library
146-
- [php-authenticator](https://github.com/chillerlan/php-authenticator) - a Google Authenticator implementation (see [authenticator example](https://github.com/chillerlan/php-qrcode/blob/main/examples/authenticator.php))
146+
- [php-authenticator](https://github.com/chillerlan/php-authenticator) - a Google Authenticator implementation (see [authenticator example](https://github.com/chillerlan/php-qrcode/blob/v5.0.x/examples/authenticator.php))
147147
- [php-httpinterface](https://github.com/chillerlan/php-httpinterface) - a PSR-7/15/17/18 implemetation
148148
- [php-oauth-core](https://github.com/chillerlan/php-oauth-core) - an OAuth 1/2 client library along with a bunch of [providers](https://github.com/chillerlan/php-oauth-providers)
149149
- [php-database](https://github.com/chillerlan/php-database) - a database client & querybuilder for MySQL, Postgres, SQLite, MSSQL, Firebird
@@ -158,7 +158,7 @@ I don't take responsibility for molten CPUs, misled applications, failed log-ins
158158
### License notice
159159

160160
- Parts of this code are [ported to PHP](https://github.com/codemasher/php-qrcode-decoder) from the [ZXing project](https://github.com/zxing/zxing) and licensed under the [Apache License, Version 2.0](./NOTICE).
161-
- [The documentation](https://github.com/chillerlan/php-qrcode/tree/main/docs) is licensed under the [Creative Commons Attribution 4.0 International (CC BY 4.0) License](https://creativecommons.org/licenses/by/4.0/).
161+
- [The documentation](https://github.com/chillerlan/php-qrcode/tree/v5.0.x/docs) is licensed under the [Creative Commons Attribution 4.0 International (CC BY 4.0) License](https://creativecommons.org/licenses/by/4.0/).
162162

163163

164164
### Trademark Notice

docs/Appendix/Contribute.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ You want to contribute code to fix something or add a feature? Hey that's cool!
5454

5555
- Please add a description of what the PR does or fixes and why it should be merged. If you're unsure, [open an issue](https://github.com/chillerlan/php-qrcode/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.md&title=%5BENHANCEMENT%5D) before to gather feedback.
5656
- Make sure your branch is up-to-date/even with the upstream branch you're submitting your PR to.
57-
- Please try to adhere to the [*loosely outlined* coding standards](https://github.com/chillerlan/php-qrcode/discussions/60), or, in case you're using [PHPStorm](https://www.jetbrains.com/phpstorm/), make sure you're using [the supplied IDE profile](https://github.com/chillerlan/php-qrcode/tree/main/.idea).
57+
- Please try to adhere to the [*loosely outlined* coding standards](https://github.com/chillerlan/php-qrcode/discussions/60), or, in case you're using [PHPStorm](https://www.jetbrains.com/phpstorm/), make sure you're using [the supplied IDE profile](https://github.com/chillerlan/php-qrcode/tree/v5.0.x/.idea).
5858

5959

6060
## Documentation
@@ -63,5 +63,5 @@ The documentation is a work in progress - any suggestion and contribution is ver
6363
If you have an addition or correction, feel fre to open a [documentation issue](https://github.com/chillerlan/php-qrcode/issues/new?assignees=&labels=docs&projects=&template=documentation.md&title=%5BDOCS%5D).
6464

6565

66-
The API documentation is auto generated with [phpDocumentor](https://www.phpdoc.org/) from the docblocks [in the PHP sources](https://github.com/chillerlan/php-qrcode/tree/main/src).
67-
The markdown sources for the [Read the Docs online manual](https://php-qrcode.readthedocs.io) are located in the [/docs directory](https://github.com/chillerlan/php-qrcode/tree/main/docs)
66+
The API documentation is auto generated with [phpDocumentor](https://www.phpdoc.org/) from the docblocks [in the PHP sources](https://github.com/chillerlan/php-qrcode/tree/v5.0.x/src).
67+
The markdown sources for the [Read the Docs online manual](https://php-qrcode.readthedocs.io) are located in the [/docs directory](https://github.com/chillerlan/php-qrcode/tree/v5.0.x/docs)

docs/Appendix/URI-Content.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ The parameters `algorithm`, `digits` and `period` may not be supported by some d
147147
- [RFC 6238 - Time-Based One-Time Password Algorithm](https://datatracker.ietf.org/doc/html/rfc6238)
148148
- [Google Authenticator (Wikipedia)](https://en.wikipedia.org/wiki/Google_Authenticator)
149149
- [google-authenticator: Key Uri Format (GitHub)](https://github.com/google/google-authenticator/wiki/Key-Uri-Format)
150-
- [php-qrcode: Authenticator example (GitHub)](https://github.com/chillerlan/php-qrcode/blob/main/examples/authenticator.php)
150+
- [php-qrcode: Authenticator example (GitHub)](https://github.com/chillerlan/php-qrcode/blob/v5.0.x/examples/authenticator.php)
151151

152152

153153
## Wireless Network configuration

0 commit comments

Comments
 (0)