1
0
mirror of https://github.com/CLIUtils/CLI11.git synced 2025-05-01 21:23:52 +00:00

docs: add more notes about releases (#617)

* docs: add more notes about releases

* docs: update badges

* ci: fix file upload
This commit is contained in:
Henry Schreiner 2021-07-14 13:29:10 -04:00 committed by GitHub
parent 0d06d21b56
commit 975e58b3ed
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 13 additions and 8 deletions

View File

@ -78,3 +78,5 @@ Steps:
* Replace " 🆕" and "🆕 " with "" (ignores the description line) * Replace " 🆕" and "🆕 " with "" (ignores the description line)
* Check for `\/\/$` (vi syntax) to catch leftover `// 🆕` * Check for `\/\/$` (vi syntax) to catch leftover `// 🆕`
* Replace "🚧" with "🆕" (manually ignore the description line) * Replace "🚧" with "🆕" (manually ignore the description line)
* Make a release in the GitHub UI, use a name such as "Version X.Y(.Z): Title"
* Currently, the release action wipes the title after you release, so remember to edit the title back to the original name after the `CLI11.hpp` file gets uploaded.

View File

@ -37,10 +37,13 @@ jobs:
- name: Make header - name: Make header
run: cmake --build build --target CLI11-generate-single-file run: cmake --build build --target CLI11-generate-single-file
- name: Copy file to main folder
run: cp build/include/CLI11.hpp CLI11.hpp
- uses: actions/upload-artifact@v2 - uses: actions/upload-artifact@v2
with: with:
name: CLI11.hpp name: CLI11.hpp
path: build/include/CLI11.hpp path: CLI11.hpp
- uses: actions/upload-artifact@v2 - uses: actions/upload-artifact@v2
with: with:

View File

@ -1,4 +1,4 @@
## Version 2.0: Cleanup & TOML ## Version 2.0: Simplification
This version focuses on cleaning up deprecated functionality, and some minor This version focuses on cleaning up deprecated functionality, and some minor
default changes. The config processing is TOML compliant now. Atomics and default changes. The config processing is TOML compliant now. Atomics and

View File

@ -1002,8 +1002,8 @@ CLI11 was developed at the [University of Cincinnati][] to support of the [GooFi
[gitter-badge]: https://badges.gitter.im/CLI11gitter/Lobby.svg [gitter-badge]: https://badges.gitter.im/CLI11gitter/Lobby.svg
[gitter]: https://gitter.im/CLI11gitter/Lobby [gitter]: https://gitter.im/CLI11gitter/Lobby
[license-badge]: https://img.shields.io/badge/License-BSD-blue.svg [license-badge]: https://img.shields.io/badge/License-BSD-blue.svg
[conan-badge]: https://api.bintray.com/packages/cliutils/CLI11/CLI11%3Acliutils/images/download.svg [conan-badge]: https://img.shields.io/badge/conan-io-blue
[conan-link]: https://bintray.com/cliutils/CLI11/CLI11%3Acliutils/_latestVersion [conan-link]: https://conan.io/center/cli11
[github releases]: https://github.com/CLIUtils/CLI11/releases [github releases]: https://github.com/CLIUtils/CLI11/releases
[github issues]: https://github.com/CLIUtils/CLI11/issues [github issues]: https://github.com/CLIUtils/CLI11/issues
[github pull requests]: https://github.com/CLIUtils/CLI11/pulls [github pull requests]: https://github.com/CLIUtils/CLI11/pulls
@ -1034,16 +1034,16 @@ CLI11 was developed at the [University of Cincinnati][] to support of the [GooFi
[version 1.0 post]: https://iscinumpy.gitlab.io/post/announcing-cli11-10/ [version 1.0 post]: https://iscinumpy.gitlab.io/post/announcing-cli11-10/
[version 1.3 post]: https://iscinumpy.gitlab.io/post/announcing-cli11-13/ [version 1.3 post]: https://iscinumpy.gitlab.io/post/announcing-cli11-13/
[version 1.6 post]: https://iscinumpy.gitlab.io/post/announcing-cli11-16/ [version 1.6 post]: https://iscinumpy.gitlab.io/post/announcing-cli11-16/
[wandbox-badge]: https://img.shields.io/badge/try_1.9-online-blue.svg [wandbox-badge]: https://img.shields.io/badge/try_2.0-online-blue.svg
[wandbox-link]: https://wandbox.org/permlink/8SirASwhbFQZyDTW [wandbox-link]: https://wandbox.org/permlink/650go2SXpfdvQ7ex
[releases-badge]: https://img.shields.io/github/release/CLIUtils/CLI11.svg [releases-badge]: https://img.shields.io/github/release/CLIUtils/CLI11.svg
[cli11-po-compare]: https://iscinumpy.gitlab.io/post/comparing-cli11-and-boostpo/ [cli11-po-compare]: https://iscinumpy.gitlab.io/post/comparing-cli11-and-boostpo/
[diana slides]: https://indico.cern.ch/event/619465/contributions/2507949/attachments/1448567/2232649/20170424-diana-2.pdf [diana slides]: https://indico.cern.ch/event/619465/contributions/2507949/attachments/1448567/2232649/20170424-diana-2.pdf
[awesome c++]: https://github.com/fffaraz/awesome-cpp/blob/master/README.md#cli [awesome c++]: https://github.com/fffaraz/awesome-cpp/blob/master/README.md#cli
[cli]: https://codesynthesis.com/projects/cli/ [cli]: https://codesynthesis.com/projects/cli/
[single file libs]: https://github.com/nothings/single_file_libs/blob/master/README.md [single file libs]: https://github.com/nothings/single_file_libs/blob/master/README.md
[codacy-badge]: https://api.codacy.com/project/badge/Grade/ac0df3aead2a4421b02070c3f324a0b9 [codacy-badge]: https://app.codacy.com/project/badge/Grade/2796b969c1b54321a02ad08affec0800
[codacy-link]: https://www.codacy.com/app/henryiii/CLI11?utm_source=github.com&utm_medium=referral&utm_content=CLIUtils/CLI11&utm_campaign=Badge_Grade [codacy-link]: https://www.codacy.com/gh/CLIUtils/CLI11/dashboard?utm_source=github.com&utm_medium=referral&utm_content=CLIUtils/CLI11&utm_campaign=Badge_Grade
[hunter]: https://docs.hunter.sh/en/latest/packages/pkg/CLI11.html [hunter]: https://docs.hunter.sh/en/latest/packages/pkg/CLI11.html
[standard readme style]: https://github.com/RichardLitt/standard-readme [standard readme style]: https://github.com/RichardLitt/standard-readme
[argparse]: https://github.com/p-ranav/argparse [argparse]: https://github.com/p-ranav/argparse