move template to subdirectory (#17)

Also add template CI to check if template is valid

Author: marcoieni

.github/workflows/build.yml

@@ -0,0 +1,36 @@
+name: Build Template
+on:
+  push:
+  # TODO Add this code block once https://github.com/cargo-generate/cargo-generate-action/issues/5 is fixed:
+  #   branches:
+  #     - main
+  # pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      PROJECT_NAME: rust-gh-example
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+      - name: Run cargo generate
+        uses: cargo-generate/[email protected]
+        with:
+          name: ${{ env.PROJECT_NAME }}
+          subfolder: template
+          template_values_file: .github/workflows/template_values.toml
+      - name: Install Rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          profile: minimal
+          override: true
+      - name: Cargo check
+        # we need to move the generated project to a temp folder, away from the template project
+        # otherwise `cargo` runs would fail
+        # see https://github.com/rust-lang/cargo/issues/9922
+        run: |
+          mv $PROJECT_NAME ${{ runner.temp }}/
+          cd ${{ runner.temp }}/$PROJECT_NAME
+          cargo check --tests

.github/workflows/template_values.toml

@@ -0,0 +1,3 @@
+[values]
+username = "rust-github"
+project-description = "Example of Rust GitHub template"

README.md

@@ -1,33 +1,6 @@
-# {{project-name}}
+# Rust Github Template
 
-[![Crates.io](https://img.shields.io/crates/v/{{project-name}}.svg)](https://crates.io/crates/{{project-name}})
-[![Docs.rs](https://docs.rs/{{project-name}}/badge.svg)](https://docs.rs/{{project-name}})
-[![CI](https://github.com/{{username}}/{{project-name}}/workflows/CI/badge.svg)](https://github.com/{{username}}/{{project-name}}/actions)
-[![Coverage Status](https://coveralls.io/repos/github/{{username}}/{{project-name}}/badge.svg?branch=main)](https://coveralls.io/github/{{username}}/{{project-name}}?branch=main)
+A template for [cargo generate](https://github.com/cargo-generate/cargo-generate) that aims to be a starting point suitable for
+the vast majority of rust projects that will be hosted on GitHub.
 
-## Installation
-
-### Cargo
-
-* Install the rust toolchain in order to have cargo installed by following
-  [this](https://www.rust-lang.org/tools/install) guide.
-* run `cargo install {{project-name}}`
-
-## License
-
-Licensed under either of
-
- * Apache License, Version 2.0
-   ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
- * MIT license
-   ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
-
-at your option.
-
-## Contribution
-
-Unless you explicitly state otherwise, any contribution intentionally submitted
-for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
-dual licensed as above, without any additional terms or conditions.
-
-See [CONTRIBUTING.md](CONTRIBUTING.md).
+See the project [website](https://rust-github.github.io).

.github/ISSUE_TEMPLATE/bug_report.md template/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+# {{project-name}}
+
+[![Crates.io](https://img.shields.io/crates/v/{{project-name}}.svg)](https://crates.io/crates/{{project-name}})
+[![Docs.rs](https://docs.rs/{{project-name}}/badge.svg)](https://docs.rs/{{project-name}})
+[![CI](https://github.com/{{username}}/{{project-name}}/workflows/CI/badge.svg)](https://github.com/{{username}}/{{project-name}}/actions)
+[![Coverage Status](https://coveralls.io/repos/github/{{username}}/{{project-name}}/badge.svg?branch=main)](https://coveralls.io/github/{{username}}/{{project-name}}?branch=main)
+
+## Installation
+
+### Cargo
+
+* Install the rust toolchain in order to have cargo installed by following
+  [this](https://www.rust-lang.org/tools/install) guide.
+* run `cargo install {{project-name}}`
+
+## License
+
+Licensed under either of
+
+ * Apache License, Version 2.0
+   ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+ * MIT license
+   ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+
+at your option.
+
+## Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
+dual licensed as above, without any additional terms or conditions.
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).