Merge #827

827: Improve release infrastructure r=Alexhuszagh a=Emilgardis



Co-authored-by: Emil Gardström <[email protected]>

Author: bors[bot]

.github/actions/cargo-publish/action.yml

@@ -4,6 +4,9 @@ inputs:
   cargo-registry-token:
     description: 'API token for crates.io'
     required: true
+  github-token:
+    description: 'Github API token'
+    required: true
 
 runs:
   using: composite
@@ -13,7 +16,7 @@ runs:
       uses: mindsers/[email protected]
       with:
         # validation_depth: 10
-        version: ${{ (github.ref_type == 'tag' && github.ref_name) || 'Unreleased' }}
+        version: ${{ (github.ref_type == 'tag' && !contains(github.ref_name, '-') && github.ref_name) || 'Unreleased' }}
         path: ./CHANGELOG.md
 
     - name: Download artifacts
@@ -30,6 +33,14 @@ runs:
         command: login
         args: -- ${{ inputs.cargo-registry-token }}
 
+    - run: gh release delete --yes Unreleased || exit 0
+      if: >
+        github.event_name == 'push' &&
+          github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
+      shell: bash
+      env:
+        GITHUB_TOKEN: ${{ inputs.github-token }}
+        
     - name: Create GitHub release
       if: >
         github.event_name == 'push' && (
@@ -38,10 +49,10 @@ runs:
         )
       uses: softprops/action-gh-release@v1
       with:
-        tag_name: ${{ steps.changelog-reader.outputs.version }}
+        tag_name: ${{ (github.ref_type == 'tag' && github.ref_name) || 'Unreleased' }}
         body: ${{ steps.changelog-reader.outputs.changes }}
-        prerelease: ${{ steps.changelog-reader.outputs.status == 'prereleased' }}
-        draft: ${{ steps.changelog-reader.outputs.status == 'unreleased' }}
+        prerelease: ${{ startsWith(github.ref, 'refs/tags/v') && contains(github.ref_name, '-') }}
+        draft: ${{ !startsWith(github.ref, 'refs/tags/v') && steps.changelog-reader.outputs.status == 'unreleased' }}
         files: |
           ${{ steps.download-artifacts.outputs.download-path }}/*/*
 

.github/workflows/ci.yml

@@ -301,6 +301,7 @@ jobs:
       - uses: ./.github/actions/cargo-publish
         with:
           cargo-registry-token: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
 
   conclusion:
     needs: [shellcheck, fmt, clippy, test, generate-matrix, build, publish]

CHANGELOG.md

@@ -3,7 +3,9 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [Unreleased]
+<!-- next-header -->
+
+## [Unreleased] - ReleaseDate
 
 ### Added
 
@@ -65,7 +67,6 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - #665 - when not using [env.volumes](https://github.com/cross-rs/cross#mounting-volumes-into-the-build-environment), mount project in /project
 - #494 - Parse Cargo's --manifest-path option to determine mounted docker root
 
-
 ### Removed
 
 - #718 - remove deb subcommand.
@@ -143,8 +144,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 [`deb`]: https://github.com/mmstick/cargo-deb
 
-- Partial `test` / `run` support for android targets. Using the android API via `cross run` / `cross
-  test` is *not* supported because Cross is using QEMU instead of the official Android emulator.
+- Partial `test` / `run` support for android targets. Using the android API via `cross run` / `cross test` is _not_ supported because Cross is using QEMU instead of the official Android emulator.
 
 - Partial support for the `sparcv9-sun-solaris` and `x86_64-sun-solaris` targets. `cross test` and
   `cross run` doesn't work for these new targets.
@@ -165,7 +165,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 - `binfmt_misc` is not required on the host for toolchain v1.19.0 and newer.
   With these toolchains `binfmt_misc` interpreters don't need to be installed
-  on the host saving a *privileged* docker run which some systems don't allow.
+  on the host saving a _privileged_ docker run which some systems don't allow.
 
 ## [v0.1.11] - 2017-06-10
 
@@ -262,9 +262,9 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 - Building older versions (<0.7.0) of the `openssl` crate is now supported.
 
-- Before Docker is invoked, `cross` will *always* (re)generate the lockfile to
+- Before Docker is invoked, `cross` will _always_ (re)generate the lockfile to
   avoid errors later on due to read/write permissions. This removes the need to
-  call `cargo generate-lockfile` before `cross` in *all* cases.
+  call `cargo generate-lockfile` before `cross` in _all_ cases.
 
 ## [v0.1.4] - 2017-01-07
 
@@ -315,6 +315,9 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 - Initial release. Supports 12 targets.
 
+<!-- prettier-ignore-start -->
+<!-- next-url -->
+
 [Unreleased]: https://github.com/cross-rs/cross/compare/v0.2.1...HEAD
 [v0.2.1]: https://github.com/cross-rs/cross/compare/v0.2.0...v0.2.1
 [v0.2.0]: https://github.com/cross-rs/cross/compare/v0.1.16...v0.2.0
@@ -334,3 +337,4 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 [v0.1.3]: https://github.com/cross-rs/cross/compare/v0.1.2...v0.1.3
 [v0.1.2]: https://github.com/cross-rs/cross/compare/v0.1.1...v0.1.2
 [v0.1.1]: https://github.com/cross-rs/cross/compare/v0.1.0...v0.1.1
+<!-- prettier-ignore-end -->

Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-build = "build.rs"
+build = "src/build.rs"
 description = "Zero setup cross compilation and cross testing"
 documentation = "https://github.com/cross-rs/cross"
 keywords = ["cross", "compilation", "testing", "tool"]
@@ -8,6 +8,17 @@ name = "cross"
 repository = "https://github.com/cross-rs/cross"
 version = "0.2.1"
 edition = "2021"
+include = [
+  "src/**/*",
+  "docker/Dockerfile.*",
+  "docker/*.sh",
+  "docs/*.md",
+  "Cargo.toml",
+  "Cargo.lock",
+  "LICENSE*",
+  "README.md",
+  "assets/*",
+]
 
 [features]
 default = []
@@ -48,3 +59,38 @@ lto = true
 regex = "1"
 once_cell = "1"
 walkdir = "2"
+
+[package.metadata.release]
+dev-version = false
+push = false
+publish = false
+tag = false
+pre-release-commit-message = "release version {{version}}"
+
+[[package.metadata.release.pre-release-replacements]]
+file = "CHANGELOG.md"
+search = "Unreleased"
+replace = "v{{version}}"
+
+[[package.metadata.release.pre-release-replacements]]
+file = "CHANGELOG.md"
+search = "\\.\\.\\.HEAD"
+replace = "...{{tag_name}}"
+exactly = 1
+
+[[package.metadata.release.pre-release-replacements]]
+file = "CHANGELOG.md"
+search = "ReleaseDate"
+replace = "{{date}}"
+
+[[package.metadata.release.pre-release-replacements]]
+file = "CHANGELOG.md"
+search = "<!-- next-header -->"
+replace = "<!-- next-header -->\n\n## [Unreleased] - ReleaseDate"
+exactly = 1
+
+[[package.metadata.release.pre-release-replacements]]
+file = "CHANGELOG.md"
+search = "<!-- next-url -->"
+replace = "<!-- next-url -->\n\n[Unreleased]: https://github.com/cross-rs/{{crate_name}}/compare/{{tag_name}}...HEAD"
+exactly = 1