Skip to content

Commit 320e599

Browse files
committed
:octocat: v6.0.x branch adjustments
1 parent bbe33a0 commit 320e599

26 files changed

Lines changed: 50 additions & 316 deletions

.github/FUNDING.yml

Lines changed: 0 additions & 1 deletion
This file was deleted.

.github/ISSUE_TEMPLATE/01-bug-report.yml

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

.github/ISSUE_TEMPLATE/02-feature-request.yml

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

.github/ISSUE_TEMPLATE/03-documentation.yml

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

.github/ISSUE_TEMPLATE/config.yml

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

.github/PULL_REQUEST_TEMPLATE.md

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

.github/workflows/ci.yml

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

1212
name: "Continuous Integration"
1313

@@ -109,71 +109,3 @@ jobs:
109109
with:
110110
project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
111111
coverage-reports: .build/coverage/clover.xml
112-
113-
114-
build-docs:
115-
name: "Build and publish API docs"
116-
if: github.ref_name == 'main'
117-
runs-on: ubuntu-latest
118-
119-
steps:
120-
- name: "Checkout sources"
121-
uses: actions/checkout@v5
122-
123-
- name: "Install PHP"
124-
uses: shivammathur/setup-php@v2
125-
with:
126-
php-version: "8.4"
127-
extensions: ${{ env.PHP_EXTENSIONS }}
128-
ini-values: ${{ env.PHP_INI_VALUES }}
129-
coverage: none
130-
tools: phpDocumentor
131-
132-
- name: "Build API docs"
133-
run: phpdoc --config=phpdoc.xml.dist
134-
135-
- name: "Publish API docs to branch gh-pages"
136-
uses: JamesIves/github-pages-deploy-action@v4
137-
with:
138-
branch: gh-pages
139-
folder: .build/phpdocs
140-
clean: true
141-
142-
143-
build-manual:
144-
name: "Build and publish user manual"
145-
if: github.ref_name == 'main'
146-
runs-on: ubuntu-latest
147-
148-
steps:
149-
- name: "Checkout sources"
150-
uses: actions/checkout@v5
151-
152-
- name: "Install PHP"
153-
uses: shivammathur/setup-php@v2
154-
with:
155-
php-version: "8.4"
156-
extensions: ${{ env.PHP_EXTENSIONS }}
157-
ini-values: ${{ env.PHP_INI_VALUES }}
158-
coverage: none
159-
160-
- name: "Install dependencies with composer"
161-
uses: ramsey/composer-install@v3
162-
163-
- name: "Install Sphinx"
164-
run: pip install sphinx myst-parser sphinx-rtd-theme
165-
166-
- name: "Build QROptions doc"
167-
run: php docs/qroptions-doc.php
168-
169-
- name: "Build manual"
170-
run: |
171-
cd docs
172-
make html
173-
174-
- name: "Publish user manual to branch readthedocs"
175-
uses: JamesIves/github-pages-deploy-action@v4
176-
with:
177-
branch: readthedocs
178-
folder: .build/sphinx/html
179-
clean: true

README.md

Lines changed: 15 additions & 15 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&logoColor=fff
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&logoColor=fff
20+
[gh-action-badge]: https://img.shields.io/github/actions/workflow/status/chillerlan/php-qrcode/ci.yml?branch=v6.0.x&logo=github&logoColor=fff
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&logoColor=fff
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&logoColor=fff
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/v6.0.x?logo=codecov&logoColor=fff
23+
[coverage]: https://app.codecov.io/gh/chillerlan/php-qrcode/tree/v6.0.x
24+
[codacy-badge]: https://img.shields.io/codacy/grade/edccfc4fe5a34b74b1c53ee03f097b8d/v6.0.x?logo=codacy&logoColor=fff
25+
[codacy]: https://app.codacy.com/gh/chillerlan/php-qrcode/dashboard?branch=v6.0.x
2626
[downloads-badge]: https://img.shields.io/packagist/dt/chillerlan/php-qrcode?logo=packagist&logoColor=fff
2727
[downloads]: https://packagist.org/packages/chillerlan/php-qrcode/stats
28-
[readthedocs-badge]: https://img.shields.io/readthedocs/php-qrcode/main?logo=readthedocs&logoColor=fff
29-
[readthedocs]: https://php-qrcode.readthedocs.io/en/main/
28+
[readthedocs-badge]: https://img.shields.io/readthedocs/php-qrcode/v6.0.x?logo=readthedocs&logoColor=fff
29+
[readthedocs]: https://php-qrcode.readthedocs.io/en/v6.0.x/
3030

3131
# Overview
3232

@@ -68,7 +68,7 @@ For the QR Code reader, either `ext-gd` or `ext-imagick` is required!
6868

6969
# Documentation
7070

71-
- The user manual is at https://php-qrcode.readthedocs.io/ ([sources](https://github.com/chillerlan/php-qrcode/tree/main/docs))
71+
- The user manual is at https://php-qrcode.readthedocs.io/ ([sources](https://github.com/chillerlan/php-qrcode/tree/v6.0.x/docs))
7272
- An API documentation created with [phpDocumentor](https://www.phpdoc.org/) can be found at https://chillerlan.github.io/php-qrcode/
7373
- The documentation for the `QROptions` container is here: [chillerlan/php-settings-container](https://github.com/chillerlan/php-settings-container#readme)
7474
- Benchmark results can be found in the [`benchmark` branch](https://github.com/chillerlan/php-qrcode/tree/benchmark/markdown)
@@ -83,7 +83,7 @@ The `main` (default) branch is the active development for future major versions,
8383

8484
## Installation with [composer](https://getcomposer.org)
8585

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

8888

8989
### Terminal
@@ -99,12 +99,12 @@ composer require chillerlan/php-qrcode
9999
{
100100
"require": {
101101
"php": "^8.2",
102-
"chillerlan/php-qrcode": "dev-main#<commit_hash>"
102+
"chillerlan/php-qrcode": "v6.0.x-dev#<commit_hash>"
103103
}
104104
}
105105
```
106106

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

109109

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

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

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

128128

@@ -134,7 +134,7 @@ I don't take responsibility for molten CPUs, misled applications, failed log-ins
134134
## License notice
135135

136136
- 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).
137-
- [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/).
137+
- [The documentation](https://github.com/chillerlan/php-qrcode/tree/v6.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/).
138138

139139

140140
## 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/v6.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/v6.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/v6.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/v6.0.x/examples/authenticator.php)
151151

152152

153153
## Wireless Network configuration

0 commit comments

Comments
 (0)