Skip to content

Commit e064736

Browse files
ednolanednolan
committed
Remove godbolt_link parameter from cookiecutter template
Asking users to provide a compiler explorer link at the same time as they create their library for the first time creates a chicken-egg situation, given that the compiler explorer links are supposed to make use of the copies of the library that are installed into compiler explorer rather than just copypastes. This change removes the parameter; users can add it to new libraries after they've set up compiler explorer support separately.
1 parent 339a75d commit e064736

4 files changed

Lines changed: 16 additions & 21 deletions

File tree

‎README.md‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,16 @@ git commit and branch:
1717

1818
```
1919
$ ./stamp.sh
20-
[1/8] project_name (my_project_name): example_library
21-
[2/8] maintainer (your_github_username): your_username
22-
[3/8] minimum_cpp_build_version (20):
23-
[4/8] paper (PnnnnRr): P9999R9
24-
[5/8] description (Short project description.):
25-
[6/8] godbolt_link (https://www.example.com):
26-
[7/8] Select library_type
20+
[1/7] project_name (my_project_name): example_library
21+
[2/7] maintainer (your_github_username): your_username
22+
[3/7] minimum_cpp_build_version (20):
23+
[4/7] paper (PnnnnRr): P9999R9
24+
[5/7] description (Short project description.):
25+
[6/7] Select library_type
2726
1 - interface
2827
2 - static
2928
Choose from [1/2] (1):
30-
[8/8] Select unit_test_library
29+
[7/7] Select unit_test_library
3130
1 - gtest
3231
2 - catch2
3332
Choose from [1/2] (1):
@@ -49,7 +48,7 @@ SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
4948
-->
5049

5150
<!-- markdownlint-disable-next-line line-length -->
52-
![Library Status](https://raw.githubusercontent.com/bemanproject/beman/refs/heads/main/images/badges/beman_badge-beman_library_under_development.svg) ![Continuous Integration Tests](https://github.com/bemanproject/exemplar/actions/workflows/ci_tests.yml/badge.svg) ![Lint Check (pre-commit)](https://github.com/bemanproject/exemplar/actions/workflows/pre-commit-check.yml/badge.svg) [![Coverage](https://coveralls.io/repos/github/bemanproject/exemplar/badge.svg?branch=main)](https://coveralls.io/github/bemanproject/exemplar?branch=main) ![Standard Target](https://github.com/bemanproject/beman/blob/main/images/badges/cpp29.svg) [![Compiler Explorer Example](https://img.shields.io/badge/Try%20it%20on%20Compiler%20Explorer-grey?logo=compilerexplorer&logoColor=67c52a)](https://godbolt.org/z/4qEPK87va)
51+
![Library Status](https://raw.githubusercontent.com/bemanproject/beman/refs/heads/main/images/badges/beman_badge-beman_library_under_development.svg) ![Continuous Integration Tests](https://github.com/bemanproject/exemplar/actions/workflows/ci_tests.yml/badge.svg) ![Lint Check (pre-commit)](https://github.com/bemanproject/exemplar/actions/workflows/pre-commit-check.yml/badge.svg) [![Coverage](https://coveralls.io/repos/github/bemanproject/exemplar/badge.svg?branch=main)](https://coveralls.io/github/bemanproject/exemplar?branch=main) ![Standard Target](https://github.com/bemanproject/beman/blob/main/images/badges/cpp29.svg)
5352

5453
`beman.exemplar` is a minimal C++ library conforming to [The Beman Standard](https://github.com/bemanproject/beman/blob/main/docs/beman_standard.md).
5554
This can be used as a template for those intending to write Beman libraries.

‎cookiecutter/check_cookiecutter.sh‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ function stamp() {
1919
minimum_cpp_build_version="17" \
2020
paper="P0898R3" \
2121
description="A Beman Library Exemplar" \
22-
godbolt_link="https://godbolt.org/z/4qEPK87va" \
2322
library_type="$library_type" \
2423
unit_test_library="$unit_test_library" \
2524
_generating_exemplar="$generating_exemplar" \
@@ -66,7 +65,6 @@ function check_templating() {
6665
minimum_cpp_build_version="17" \
6766
paper="P0898R3" \
6867
description="A Beman Library RLZrmX9NfS" \
69-
godbolt_link="https://godbolt.org/z/4qEPK87va" \
7068
_generating_exemplar="false" \
7169
_ci_tests_cron="30 15 * * 6" \
7270
_pre_commit_update_cron="0 16 * * 0"

‎cookiecutter/cookiecutter.json‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
"minimum_cpp_build_version": "20",
55
"paper": "PnnnnRr",
66
"description": "Short project description.",
7-
"godbolt_link": "https://www.example.com",
87
"library_type": ["interface", "static"],
98
"unit_test_library": ["gtest", "catch2"],
109
"_generating_exemplar": false,

‎cookiecutter/{{cookiecutter.project_name}}/README.md‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,16 @@ git commit and branch:
1818

1919
```
2020
$ ./stamp.sh
21-
[1/8] project_name (my_project_name): example_library
22-
[2/8] maintainer (your_github_username): your_username
23-
[3/8] minimum_cpp_build_version (20):
24-
[4/8] paper (PnnnnRr): P9999R9
25-
[5/8] description (Short project description.):
26-
[6/8] godbolt_link (https://www.example.com):
27-
[7/8] Select library_type
21+
[1/7] project_name (my_project_name): example_library
22+
[2/7] maintainer (your_github_username): your_username
23+
[3/7] minimum_cpp_build_version (20):
24+
[4/7] paper (PnnnnRr): P9999R9
25+
[5/7] description (Short project description.):
26+
[6/7] Select library_type
2827
1 - interface
2928
2 - static
3029
Choose from [1/2] (1):
31-
[8/8] Select unit_test_library
30+
[7/7] Select unit_test_library
3231
1 - gtest
3332
2 - catch2
3433
Choose from [1/2] (1):
@@ -51,7 +50,7 @@ SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
5150
-->
5251

5352
<!-- markdownlint-disable-next-line line-length -->
54-
![Library Status](https://raw.githubusercontent.com/bemanproject/beman/refs/heads/main/images/badges/beman_badge-beman_library_under_development.svg) ![Continuous Integration Tests](https://github.com/{{cookiecutter._owner}}/{{cookiecutter.project_name}}/actions/workflows/ci_tests.yml/badge.svg) ![Lint Check (pre-commit)](https://github.com/{{cookiecutter._owner}}/{{cookiecutter.project_name}}/actions/workflows/pre-commit-check.yml/badge.svg) [![Coverage](https://coveralls.io/repos/github/{{cookiecutter._owner}}/{{cookiecutter.project_name}}/badge.svg?branch=main)](https://coveralls.io/github/{{cookiecutter._owner}}/{{cookiecutter.project_name}}?branch=main) ![Standard Target](https://github.com/bemanproject/beman/blob/main/images/badges/cpp29.svg) [![Compiler Explorer Example](https://img.shields.io/badge/Try%20it%20on%20Compiler%20Explorer-grey?logo=compilerexplorer&logoColor=67c52a)]({{cookiecutter.godbolt_link}})
53+
![Library Status](https://raw.githubusercontent.com/bemanproject/beman/refs/heads/main/images/badges/beman_badge-beman_library_under_development.svg) ![Continuous Integration Tests](https://github.com/{{cookiecutter._owner}}/{{cookiecutter.project_name}}/actions/workflows/ci_tests.yml/badge.svg) ![Lint Check (pre-commit)](https://github.com/{{cookiecutter._owner}}/{{cookiecutter.project_name}}/actions/workflows/pre-commit-check.yml/badge.svg) [![Coverage](https://coveralls.io/repos/github/{{cookiecutter._owner}}/{{cookiecutter.project_name}}/badge.svg?branch=main)](https://coveralls.io/github/{{cookiecutter._owner}}/{{cookiecutter.project_name}}?branch=main) ![Standard Target](https://github.com/bemanproject/beman/blob/main/images/badges/cpp29.svg)
5554

5655
`beman.{{cookiecutter.project_name}}` is a minimal C++ library conforming to [The Beman Standard](https://github.com/bemanproject/beman/blob/main/docs/beman_standard.md).
5756
This can be used as a template for those intending to write Beman libraries.

0 commit comments

Comments
 (0)