diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index cb0f84f..e438e9a 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -17,7 +17,7 @@ jobs: steps: # Check out code - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 # This is the a separate action that sets up buildx runner - name: Login to DockerHub uses: docker/login-action@v1 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 33751ef..76b6ca5 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -18,7 +18,7 @@ jobs: steps: # Check out code - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Docker meta id: meta uses: docker/metadata-action@v3 @@ -51,4 +51,4 @@ jobs: release_name: Release ${{ github.ref }} body: Latest Release prerelease: false - draft: false \ No newline at end of file + draft: false diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..ec3fcd0 --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,25 @@ +name: Test +on: [push, pull_request] + +jobs: + build: + runs-on: ubuntu-latest + env: + PROJECT_NAME: test-template + steps: + - uses: actions/checkout@v4 + + - name: Build Docker image + run: docker build -t test-cargo-generate . + + - name: Run list + run: docker run -v ${PWD}/test:/test -w /test test-cargo-generate --path /test --name ${{ env.PROJECT_NAME }} + + - uses: dtolnay/rust-toolchain@stable + # 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 ${PWD}/test/${{ env.PROJECT_NAME }} ${{ runner.temp }}/ + cd ${{ runner.temp }}/$PROJECT_NAME + cargo check diff --git a/.github/workflows/versioning.yml b/.github/workflows/versioning.yml index b87a6cd..2c3972e 100644 --- a/.github/workflows/versioning.yml +++ b/.github/workflows/versioning.yml @@ -10,6 +10,6 @@ jobs: steps: - uses: Actions-R-Us/actions-tagger@latest env: - GITHUB_TOKEN: "${{secrets.GITHUB_TOKEN}}" + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: - publish_latest_tag: true \ No newline at end of file + publish_latest_tag: true diff --git a/Dockerfile b/Dockerfile index 90cea42..eb4fd6b 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,12 +1,15 @@ -FROM rust:latest as builder -RUN cargo install cargo-generate +FROM rust:1.73.0-alpine3.18 -FROM debian:stable-slim +ENV CARGO_GEN_VERSION="0.18.4" -RUN apt-get update \ - && apt-get install -y ca-certificates curl openssl libssl1.1 libcurl4-openssl-dev +# downloads from: https://github.com/cargo-generate/cargo-generate/releases/download/v0.18.4/cargo-generate-v0.18.4-x86_64-unknown-linux-musl.tar.gz +RUN set -eux; \ + apk update; \ + apk add bash curl git tar; \ + curl --silent -L https://github.com/cargo-generate/cargo-generate/releases/download/v$CARGO_GEN_VERSION/cargo-generate-v$CARGO_GEN_VERSION-x86_64-unknown-linux-musl.tar.gz | tar xzv -C /usr/bin/; -COPY --from=builder /usr/local/cargo/bin/cargo-generate /usr/bin +# Ensure rustup is up to date. +RUN bash -c "sh <(curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs) -y" # in order to avoid permission issues # match here the GH runner UID and GID, so that generated files @@ -16,8 +19,8 @@ ARG UID=1001 ARG GID=121 ARG USERNAME=runner ARG GROUPNAME=docker -RUN groupadd -g $GID -o $GROUPNAME -RUN useradd -m -u $UID -g $GID -o -s /bin/bash $USERNAME +RUN addgroup -g $GID $GROUPNAME +RUN adduser -D -H -u $UID -s /bin/bash $USERNAME $GROUPNAME USER $USERNAME COPY entrypoint.sh /entrypoint.sh diff --git a/README.md b/README.md index da3cb2e..33d4a79 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ # cargo-generate GitHub Action -This action is used to run the `cargo-generate` tool in order to expand a template. - -This is pushed to [docker hub cargogenerate/cargo-generate-action](https://hub.docker.com/r/cargogenerate/cargo-generate-action). +This action runs `cargo-generate` to expand a template. ## Inputs @@ -16,28 +14,16 @@ This is the name of the project being expanded. This is the path to the repository holding the template. Defaults to `.` -### `branch` - -Branch for cloning the template. - -### `subfolder` - -Subfolder within the template repository that'll be used as the template. - -### `template_values_file` - -Specifies a file holding the values required for template expansion. - -> NOTE: `cargo-generate` is being run with the `--silent` option, so it will fail if any values are undefined during expansion. +### `arguments` -### `other` +All other arguments that cargo-generate accepts -This can be used to specify any other option for `cargo-generate`. +> NOTE: `cargo-generate` runs with the `--silent` option, so it will fail if any values are undefined during expansion. Example: ```yml -other: "--define foo=\"value\" --define bar=42" +arguments: "--branch x --define foo=\"value\" --define bar=42" ``` ## Example @@ -51,10 +37,10 @@ jobs: build: runs-on: ubuntu-latest env: - PROJECT_NAME: mytemplate + PROJECT_NAME: project-foo steps: - - uses: actions/checkout@v3 - - uses: cargo-generate/cargo-generate-action@v0.18 + - uses: actions/checkout@v4 + - uses: cargo-generate/cargo-generate-action@latest with: name: ${{ env.PROJECT_NAME }} - uses: actions-rs/toolchain@v1 diff --git a/action.yml b/action.yml index 575c940..52c237d 100644 --- a/action.yml +++ b/action.yml @@ -8,18 +8,14 @@ inputs: description: '--path argument' required: false default: '.' - branch: - description: '--branch argument' - required: false - subfolder: - description: '--subfolder argument' - required: false - template_values_file: - description: '--template-values-file argument' - required: false - other: - description: 'expanded to additional parameters! e.g. "-d foo=\"value1\" -d bar=\"value2\""' + arguments: + description: "The arguments to pass to cargo-generate" required: false + runs: using: 'docker' - image: 'docker://cargogenerate/cargo-generate-action:0.18.3' + image: 'Dockerfile' + args: + - --path ${{ inputs.template }} + - ${{ inputs.arguments }} + - ${{ inputs.name }} diff --git a/entrypoint.sh b/entrypoint.sh index 48b72eb..86c8fd7 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -1,35 +1,10 @@ #!/bin/bash +set -e -if [ -z "${INPUT_TEMPLATE}" ]; then - TEMPLATE="." -else - TEMPLATE=${INPUT_TEMPLATE} -fi - -if [ -z "${INPUT_BRANCH}" ]; then - BRANCH="" -else - BRANCH="--branch ${INPUT_BRANCH}" -fi - -if [ -z "${INPUT_TEMPLATE_VALUES_FILE}" ]; then - TEMPLATE_VALUES_FILE="" -else - TEMPLATE_VALUES_FILE="--template-values-file ${INPUT_TEMPLATE_VALUES_FILE}" -fi +export PATH=$PATH:/usr/local/cargo/bin -# USER variable MUST be set -if [ -z "${USER}" ]; then - export USER="root" +if [ -z "$USER" ]; then + export USER="runner" fi -set -o xtrace -cargo-generate generate\ - --silent\ - ${BRANCH}\ - ${SUBFOLDER}\ - ${TEMPLATE_VALUES_FILE}\ - ${INPUT_OTHER[@]}\ - --path ${TEMPLATE}\ - --name ${INPUT_NAME}\ - ${INPUT_SUBFOLDER} +/usr/bin/cargo-generate generate --silent $* diff --git a/test/.gitignore b/test/.gitignore new file mode 100644 index 0000000..4e30131 --- /dev/null +++ b/test/.gitignore @@ -0,0 +1,6 @@ +/target +**/*.rs.bk +Cargo.lock +bin/ +pkg/ +wasm-pack.log diff --git a/test/Cargo.toml b/test/Cargo.toml new file mode 100644 index 0000000..24514d4 --- /dev/null +++ b/test/Cargo.toml @@ -0,0 +1,34 @@ +[package] +name = "{{project-name}}" +version = "0.1.0" +authors = ["{{authors}}"] +edition = "2018" + +[lib] +crate-type = ["cdylib", "rlib"] + +[features] +default = ["console_error_panic_hook"] + +[dependencies] +wasm-bindgen = "0.2.63" + +# The `console_error_panic_hook` crate provides better debugging of panics by +# logging them with `console.error`. This is great for development, but requires +# all the `std::fmt` and `std::panicking` infrastructure, so isn't great for +# code size when deploying. +console_error_panic_hook = { version = "0.1.6", optional = true } + +# `wee_alloc` is a tiny allocator for wasm that is only ~1K in code size +# compared to the default allocator's ~10K. It is slower than the default +# allocator, however. +# +# Unfortunately, `wee_alloc` requires nightly Rust when targeting wasm for now. +wee_alloc = { version = "0.4.5", optional = true } + +[dev-dependencies] +wasm-bindgen-test = "0.3.13" + +[profile.release] +# Tell `rustc` to optimize for small code size. +opt-level = "s" diff --git a/test/LICENSE_APACHE b/test/LICENSE_APACHE new file mode 100644 index 0000000..1b5ec8b --- /dev/null +++ b/test/LICENSE_APACHE @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS diff --git a/test/LICENSE_MIT b/test/LICENSE_MIT new file mode 100644 index 0000000..a15266c --- /dev/null +++ b/test/LICENSE_MIT @@ -0,0 +1,25 @@ +Copyright (c) 2018 {{authors}} + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. diff --git a/test/README.md b/test/README.md new file mode 100644 index 0000000..1e4617a --- /dev/null +++ b/test/README.md @@ -0,0 +1,69 @@ +
+ +

wasm-pack-template

+ + A template for kick starting a Rust and WebAssembly project using wasm-pack. + +

+ Build Status +

+ +

+ Tutorial + | + Chat +

+ + Built with 🦀🕸 by The Rust and WebAssembly Working Group +
+ +## About + +[**📚 Read this template tutorial! 📚**][template-docs] + +This template is designed for compiling Rust libraries into WebAssembly and +publishing the resulting package to NPM. + +Be sure to check out [other `wasm-pack` tutorials online][tutorials] for other +templates and usages of `wasm-pack`. + +[tutorials]: https://rustwasm.github.io/docs/wasm-pack/tutorials/index.html +[template-docs]: https://rustwasm.github.io/docs/wasm-pack/tutorials/npm-browser-packages/index.html + +## 🚴 Usage + +### 🐑 Use `cargo generate` to Clone this Template + +[Learn more about `cargo generate` here.](https://github.com/ashleygwilliams/cargo-generate) + +``` +cargo generate --git https://github.com/rustwasm/wasm-pack-template.git --name my-project +cd my-project +``` + +### 🛠️ Build with `wasm-pack build` + +``` +wasm-pack build +``` + +### 🔬 Test in Headless Browsers with `wasm-pack test` + +``` +wasm-pack test --headless --firefox +``` + +### 🎁 Publish to NPM with `wasm-pack publish` + +``` +wasm-pack publish +``` + +## 🔋 Batteries Included + +* [`wasm-bindgen`](https://github.com/rustwasm/wasm-bindgen) for communicating + between WebAssembly and JavaScript. +* [`console_error_panic_hook`](https://github.com/rustwasm/console_error_panic_hook) + for logging panic messages to the developer console. +* [`wee_alloc`](https://github.com/rustwasm/wee_alloc), an allocator optimized + for small code size. diff --git a/test/src/lib.rs b/test/src/lib.rs new file mode 100644 index 0000000..7f20bc7 --- /dev/null +++ b/test/src/lib.rs @@ -0,0 +1,19 @@ +mod utils; + +use wasm_bindgen::prelude::*; + +// When the `wee_alloc` feature is enabled, use `wee_alloc` as the global +// allocator. +#[cfg(feature = "wee_alloc")] +#[global_allocator] +static ALLOC: wee_alloc::WeeAlloc = wee_alloc::WeeAlloc::INIT; + +#[wasm_bindgen] +extern { + fn alert(s: &str); +} + +#[wasm_bindgen] +pub fn greet() { + alert("Hello, {{project-name}}!"); +} diff --git a/test/src/utils.rs b/test/src/utils.rs new file mode 100644 index 0000000..b1d7929 --- /dev/null +++ b/test/src/utils.rs @@ -0,0 +1,10 @@ +pub fn set_panic_hook() { + // When the `console_error_panic_hook` feature is enabled, we can call the + // `set_panic_hook` function at least once during initialization, and then + // we will get better error messages if our code ever panics. + // + // For more details see + // https://github.com/rustwasm/console_error_panic_hook#readme + #[cfg(feature = "console_error_panic_hook")] + console_error_panic_hook::set_once(); +} diff --git a/test/tests/web.rs b/test/tests/web.rs new file mode 100644 index 0000000..de5c1da --- /dev/null +++ b/test/tests/web.rs @@ -0,0 +1,13 @@ +//! Test suite for the Web and headless browsers. + +#![cfg(target_arch = "wasm32")] + +extern crate wasm_bindgen_test; +use wasm_bindgen_test::*; + +wasm_bindgen_test_configure!(run_in_browser); + +#[wasm_bindgen_test] +fn pass() { + assert_eq!(1 + 1, 2); +}