From 73e6030b4d4792d35ebf4869c2b6aac4245b7316 Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Thu, 20 Oct 2022 19:15:03 +0100 Subject: [PATCH] Initial project setup. --- .cargo-rdme.toml | 1 + .codecov.yml | 16 ++ .gitattributes | 1 + .github/dependabot.yml | 6 + .github/workflows/ci.yml | 50 ++++++ .gitignore | 7 + .rustfmt.toml | 10 ++ CONTRIBUTING.md | 11 ++ Cargo.toml | 40 +++++ LICENSE.md | 355 +++++++++++++++++++++++++++++++++++++++ README.md | 16 ++ examples/example.rs | 3 + release-notes.md | 5 + src/lib.rs | 10 ++ tools/check.sh | 48 ++++++ tools/codecov.sh | 45 +++++ tools/release.sh | 84 +++++++++ tools/utils.sh | 20 +++ 18 files changed, 728 insertions(+) create mode 100644 .cargo-rdme.toml create mode 100644 .codecov.yml create mode 100644 .gitattributes create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/ci.yml create mode 100644 .gitignore create mode 100644 .rustfmt.toml create mode 100644 CONTRIBUTING.md create mode 100644 Cargo.toml create mode 100644 LICENSE.md create mode 100644 README.md create mode 100644 examples/example.rs create mode 100644 release-notes.md create mode 100644 src/lib.rs create mode 100755 tools/check.sh create mode 100755 tools/codecov.sh create mode 100755 tools/release.sh create mode 100644 tools/utils.sh diff --git a/.cargo-rdme.toml b/.cargo-rdme.toml new file mode 100644 index 0000000..92e26ae --- /dev/null +++ b/.cargo-rdme.toml @@ -0,0 +1 @@ +line-terminator = "lf" diff --git a/.codecov.yml b/.codecov.yml new file mode 100644 index 0000000..372b2b9 --- /dev/null +++ b/.codecov.yml @@ -0,0 +1,16 @@ +codecov: + notify: + require_ci_to_pass: yes + +coverage: + precision: 2 + round: down + range: "80...100" + + status: + project: + default: + target: auto + threshold: 10% + patch: no + changes: no diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..6313b56 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +* text=auto eol=lf diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..219c13a --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,6 @@ +version: 2 +updates: + - package-ecosystem: "cargo" + directory: "/" + schedule: + interval: "daily" diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..411a138 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,50 @@ +name: CI + +on: + push: + branches: [ master ] + pull_request: + branches: [ master ] + schedule: + - cron: '0 19 * * 3' + +env: + CARGO_TERM_COLOR: always + +jobs: + build: + + runs-on: ${{ matrix.os }} + + strategy: + matrix: + os: [ubuntu-latest, macos-latest, windows-latest] + + steps: + - name: Install rust stable + uses: actions-rs/toolchain@v1 + with: + toolchain: stable + override: true + default: true + components: rustfmt + + - name: Install cargo plugins + run: | + cargo install cargo-rdme + cargo install cargo-deadlinks + + - name: Checkout repository + uses: actions/checkout@v2 + with: + fetch-depth: 2 + + - name: Check everything + run: bash ./tools/check.sh + + - name: Code coverage + if: ${{ runner.os == 'Linux' }} + run: | + cargo install cargo-tarpaulin + ./tools/codecov.sh --xml + bash <(curl -s https://codecov.io/bash) diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..84c45ce --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +/.idea/ + +/target/ +*.rs.bk + +/Cargo.lock +/tarpaulin-report.html diff --git a/.rustfmt.toml b/.rustfmt.toml new file mode 100644 index 0000000..1709540 --- /dev/null +++ b/.rustfmt.toml @@ -0,0 +1,10 @@ +edition = "2021" + +use_field_init_shorthand = true +use_try_shorthand = true +use_small_heuristics = "max" + +# TODO Awaiting stabilization +# comment_width = 100 +# match_arm_blocks = false +# struct_field_align_threshold = 4 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..aa0fbf0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,11 @@ +# Contributing to dirty-debug + +Thank you for your interest in contributing to dirty-debug. We appreciate it! + +If you are contributing with a pull request you might want to know about a few scripts: + +* [`./tools/check.sh`](tools/check.sh) — Checks that everything is fine. This includes checking that everything + builds, the unit tests pass, and the code is correctly formatted. If you need to format the code run + `cargo fmt`. +* [`./tools/codecov.sh`](tools/codecov.sh) — Creates a code coverage report. There is not a strict code coverage + threshold, but we do want pretty much everything tested. diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..3ad2ed1 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,40 @@ +[package] +name = "dirty-debug" +description = "Quick and dirty debugging" +version = "0.0.0-pre" +authors = ["Diogo Sousa "] + +edition = "2021" + +homepage = "https://github.com/orium/dirty-debug" +repository = "https://github.com/orium/dirty-debug" +documentation = "https://docs.rs/dirty-debug" +readme = "README.md" + +keywords = [ + "debug", +] + +categories = [ + "development-tools", +] + +license = "MPL-2.0" + +# What to include when packaging. +include = [ + "/src/**/*.rs", + "/Cargo.toml", + "/LICENSE.md", + "/README.md", + "/release-notes.md", +] + +[badges] +codecov = { repository = "orium/dirty-debug", branch = "master", service = "github" } + +[features] +fatal-warnings = [] + +[dependencies] + diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..cd44203 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,355 @@ +Mozilla Public License Version 2.0 +================================== + +### 1. Definitions + +**1.1. “Contributor”** + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +**1.2. “Contributor Version”** + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +**1.3. “Contribution”** + means Covered Software of a particular Contributor. + +**1.4. “Covered Software”** + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +**1.5. “Incompatible With Secondary Licenses”** + means + +* **(a)** that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or +* **(b)** that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +**1.6. “Executable Form”** + means any form of the work other than Source Code Form. + +**1.7. “Larger Work”** + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +**1.8. “License”** + means this document. + +**1.9. “Licensable”** + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +**1.10. “Modifications”** + means any of the following: + +* **(a)** any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or +* **(b)** any new file in Source Code Form that contains any Covered + Software. + +**1.11. “Patent Claims” of a Contributor** + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +**1.12. “Secondary License”** + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +**1.13. “Source Code Form”** + means the form of the work preferred for making modifications. + +**1.14. “You” (or “Your”)** + means an individual or a legal entity exercising rights under this + License. For legal entities, “You” includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, “control” means **(a)** the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or **(b)** ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + + +### 2. License Grants and Conditions + +#### 2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +* **(a)** under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and +* **(b)** under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +#### 2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +#### 2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +* **(a)** for any code that a Contributor has removed from Covered Software; + or +* **(b)** for infringements caused by: **(i)** Your and any other third party's + modifications of Covered Software, or **(ii)** the combination of its + Contributions with other software (except as part of its Contributor + Version); or +* **(c)** under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +#### 2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +#### 2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +#### 2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +#### 2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + + +### 3. Responsibilities + +#### 3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +#### 3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +* **(a)** such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +* **(b)** You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +#### 3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +#### 3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +#### 3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + + +### 4. Inability to Comply Due to Statute or Regulation + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: **(a)** comply with +the terms of this License to the maximum extent possible; and **(b)** +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + + +### 5. Termination + +**5.1.** The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated **(a)** provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and **(b)** on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +**5.2.** If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +**5.3.** In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + + +### 6. Disclaimer of Warranty + +> Covered Software is provided under this License on an “as is” +> basis, without warranty of any kind, either expressed, implied, or +> statutory, including, without limitation, warranties that the +> Covered Software is free of defects, merchantable, fit for a +> particular purpose or non-infringing. The entire risk as to the +> quality and performance of the Covered Software is with You. +> Should any Covered Software prove defective in any respect, You +> (not any Contributor) assume the cost of any necessary servicing, +> repair, or correction. This disclaimer of warranty constitutes an +> essential part of this License. No use of any Covered Software is +> authorized under this License except under this disclaimer. + +### 7. Limitation of Liability + +> Under no circumstances and under no legal theory, whether tort +> (including negligence), contract, or otherwise, shall any +> Contributor, or anyone who distributes Covered Software as +> permitted above, be liable to You for any direct, indirect, +> special, incidental, or consequential damages of any character +> including, without limitation, damages for lost profits, loss of +> goodwill, work stoppage, computer failure or malfunction, or any +> and all other commercial damages or losses, even if such party +> shall have been informed of the possibility of such damages. This +> limitation of liability shall not apply to liability for death or +> personal injury resulting from such party's negligence to the +> extent applicable law prohibits such limitation. Some +> jurisdictions do not allow the exclusion or limitation of +> incidental or consequential damages, so this exclusion and +> limitation may not apply to You. + + +### 8. Litigation + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + + +### 9. Miscellaneous + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + + +### 10. Versions of the License + +#### 10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +#### 10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +#### 10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +#### 10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +## Exhibit A - Source Code Form License Notice + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +## Exhibit B - “Incompatible With Secondary Licenses” Notice + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f6b730d --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +[![Build Status](https://github.com/orium/dirty-debug/workflows/CI/badge.svg)](https://github.com/orium/dirty-debug/actions?query=workflow%3ACI) +[![Code Coverage](https://codecov.io/gh/orium/dirty-debug/branch/master/graph/badge.svg)](https://codecov.io/gh/orium/dirty-debug) +[![Dependency status](https://deps.rs/repo/github/orium/dirty-debug/status.svg)](https://deps.rs/repo/github/orium/dirty-debug) +[![crates.io](https://img.shields.io/crates/v/dirty-debug.svg)](https://crates.io/crates/dirty-debug) +[![Downloads](https://img.shields.io/crates/d/dirty-debug.svg)](https://crates.io/crates/dirty-debug) +[![Github stars](https://img.shields.io/github/stars/orium/dirty-debug.svg?logo=github)](https://github.com/orium/dirty-debug/stargazers) +[![Documentation](https://docs.rs/dirty-debug/badge.svg)](https://docs.rs/dirty-debug/) +[![License](https://img.shields.io/crates/l/dirty-debug.svg)](./LICENSE.md) + +# Dirty debug + + + +WIP + + diff --git a/examples/example.rs b/examples/example.rs new file mode 100644 index 0000000..cbdbc7f --- /dev/null +++ b/examples/example.rs @@ -0,0 +1,3 @@ +fn main() { + // WIP +} diff --git a/release-notes.md b/release-notes.md new file mode 100644 index 0000000..594e4b7 --- /dev/null +++ b/release-notes.md @@ -0,0 +1,5 @@ +# Release notes + +## 0.0.0 + +* Initial release to reserve the crate's name in crates.io. diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..b4857b6 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,10 @@ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ + +#![cfg_attr(feature = "fatal-warnings", deny(warnings))] +#![deny(clippy::correctness)] +#![warn(clippy::pedantic)] +// Note: If you change this remember to update `README.md`. To do so run `./tools/update-readme.sh`. +//! WIP diff --git a/tools/check.sh b/tools/check.sh new file mode 100755 index 0000000..a7585ce --- /dev/null +++ b/tools/check.sh @@ -0,0 +1,48 @@ +#!/bin/bash +# +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. + +set -e + +cd $(dirname "$0") +cd "$(git rev-parse --show-toplevel)" + +source "tools/utils.sh" + +RED='\033[0;31m' +GREEN='\033[0;32m' +NC='\033[0m' + +function on_failure { + echo >&2 + echo -e "${RED}Whoopsie-daisy: something failed!$NC" >&2 +} + +assert_installed "cargo-deadlinks" +assert_installed "cargo-fmt" + +trap on_failure ERR + +echo 'Building:' +cargo build --features fatal-warnings --all-targets +echo 'Testing:' +cargo test --features fatal-warnings --all-targets +echo 'Checking documentation:' +cargo doc --features fatal-warnings --no-deps --document-private-items + +echo 'Checking links:' +cargo deadlinks + +echo 'Checking packaging:' +cargo package --allow-dirty +echo 'Checking code style:' +cargo fmt -- --check +echo 'Checking readme:' +cargo rdme --check + +echo +echo -e "${GREEN}Everything looks lovely!$NC" + +exit 0 diff --git a/tools/codecov.sh b/tools/codecov.sh new file mode 100755 index 0000000..9680cdd --- /dev/null +++ b/tools/codecov.sh @@ -0,0 +1,45 @@ +#!/bin/bash +# +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. + +set -e + +cd $(dirname "$0") +cd "$(git rev-parse --show-toplevel)" + +source "tools/utils.sh" + +assert_installed "cargo-tarpaulin" + +output_format=Html + +args=$(getopt -l "xml" -o "x" -- "$@") + +eval set -- "$args" + +while [ $# -ge 1 ]; do + case "$1" in + --) + # No more options left. + shift + break + ;; + -x|--xml) + output_format=Xml + shift + ;; + esac + + shift +done + +# TODO it seems the `--force-clean` is not working. +cargo clean +cargo tarpaulin --force-clean --ignore-panics --engine llvm --timeout 1200 --out $output_format + +if [ "$output_format" == "Html" ]; then + echo + echo "You can find the test coverage results at file://$(pwd)/tarpaulin-report.html" +fi diff --git a/tools/release.sh b/tools/release.sh new file mode 100755 index 0000000..d7f986e --- /dev/null +++ b/tools/release.sh @@ -0,0 +1,84 @@ +#!/bin/bash +# +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. + +set -e + +cd $(dirname "$0") +cd "$(git rev-parse --show-toplevel)" + +source "tools/utils.sh" + +function set_version { + local version=$1 + + sed -i "0,/version = .*$/s//version = \"$version\"/" Cargo.toml + + # Update version in `Cargo.lock`. + cargo update -p $(project_name) --offline +} + +if [ $(git symbolic-ref --short HEAD) != main ]; then + echo "Not in main branch." >&2 + exit 1 +fi + +if [ $(git status --porcelain | wc -l) -ne 0 ]; then + echo "Working directory is not clean." >&2 + exit 1 +fi + +echo "Current version is $(project_version)." + +echo -n "Which version do you want to release? " +read release_version + +if ! grep "^## " release-notes.md | head -1 | grep --silent "^## $release_version$"; then + echo "You forgot to update the release notes." >&2 + exit 1 +fi + +echo -n "Which will be the next version? " +read next_version + +if ! echo "$next_version" | grep --silent -- "-pre$"; then + echo 'Next version must end in `-pre`.' >&2 +fi + +echo +echo "Current version: $(project_version)" +echo "Release version: $release_version" +echo "Next version: $next_version" +echo +echo -n 'Does this look right [yes/no]? ' + +read answer + +if [ "$answer" != "yes" ]; then + exit 0 +fi + +echo -n "Running tests... " + +if ! ./tools/check.sh 2>/dev/null > /dev/null; then + echo "It failed :(" >&2 + exit 0 +fi + +echo "done." + +set_version "$release_version" + +git commit -am "Release v${release_version}." +git tag --sign -a "v${release_version}" -m "$(project_name) version ${release_version}." + +set_version "$next_version" + +git commit -am "Bump to version $next_version." + +echo "Check if everything is alright. If so do:" +echo +echo " git checkout \"v${release_version}\" && cargo publish && git checkout main && git push --follow-tags" +echo diff --git a/tools/utils.sh b/tools/utils.sh new file mode 100644 index 0000000..0aa07fe --- /dev/null +++ b/tools/utils.sh @@ -0,0 +1,20 @@ +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. + +function assert_installed { + local bin="$1" + + if ! [ -x "$(which "$bin" 2> /dev/null)" ]; then + echo "error: $bin not installed." >&2 + exit 1 + fi +} + +function project_name { + cargo pkgid | tac -s'/' | head -1 | cut -d'#' -f1 +} + +function project_version { + cargo pkgid | tac -s'/' | head -1 | cut -d'#' -f2 +}