diff --git a/.github/workflows/release-plz.yml b/.github/workflows/release-plz.yml deleted file mode 100644 index 21bcecb..0000000 --- a/.github/workflows/release-plz.yml +++ /dev/null @@ -1,36 +0,0 @@ -name: Release-plz - -permissions: - pull-requests: write - contents: write - -on: - push: - branches: - - main - -jobs: - release-plz: - name: Release-plz - runs-on: ubuntu-latest - steps: - # Generating a GitHub token, so that PRs and tags created by - # the release-plz-action can trigger actions workflows. - - name: Generate GitHub token - uses: actions/create-github-app-token@v1 - id: generate-token - with: - app-id: ${{ secrets.APP_ID }} # <-- GitHub App ID secret name - private-key: ${{ secrets.APP_PRIVATE_KEY }} # <-- GitHub App private key secret name - - name: Checkout repository - uses: actions/checkout@v4 - with: - fetch-depth: 0 - token: ${{ steps.generate-token.outputs.token }} - - name: Install Rust toolchain - uses: dtolnay/rust-toolchain@stable - - name: Run release-plz - uses: MarcoIeni/release-plz-action@main - env: - GITHUB_TOKEN: ${{ steps.generate-token.outputs.token }} - CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }} diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index bfc95f9..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,53 +0,0 @@ -# Changelog -All notable changes to this project will be documented in this file. - -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). - -## [Unreleased] - -## [1.0.0-rc.2](https://github.com/MrHedmad/kerblam/compare/v1.0.0-rc.1...v1.0.0-rc.2) - 2024-05-07 - -### Added -- add workflows community metadata and icons -- start using callouts in the book -- rename 'skip-build-cache' to 'no-build-cache' -- add flag to skip using container cache at build time -- cache is now a JSON for greater future extendability -- better (test) error reporting upon pipeline failure -- *(execution)* make cache path finding more robust -- *(execution)* properly manage timestamps of profile files - -### Fixed -- calling type for docker with cache was wrong -- make properly changes working directory following kerblam.toml in docker - -### Other -- *(deps)* bump rustls from 0.21.10 to 0.21.11 -- add callout to block -- Merge branch 'main' into book-callouts -- remove wrong mention of extra arguments to build backend -- mention the 'skip-build-cache' flag -- extracted cache code as a module -- Merge branch 'main' into cache_profiles -- manually applied clippy suggestions -- apply clippy auto-fixes -- Merge branch 'main' into extra_args -- *(deps)* bump actions/configure-pages from 4 to 5 -- fix landing image background -- miscellaneous book typos fix and clarifications -- update landing page figure -- modify landing page figure -- *(ci)* update release-plz to use bot account -- *(deps)* bump actions/deploy-pages from 1 to 4 -- Merge branch 'main' into dependabot/github_actions/actions/upload-pages-artifact-3 -- Merge branch 'main' into dependabot/github_actions/actions/configure-pages-4 -- update cargo dist -- mention new CI in CONTRIBUTING.md -- trigger release-plz -- add release-plz -- add kerblam favicon -- force default dark + ayu theme -- *(deps)* bump mio from 0.8.10 to 0.8.11 -- add pre-release installation warning to README -- Update README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2546e8c..46ddd94 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -87,11 +87,17 @@ due to your specific environment before starting the debug process. ## Cutting releases -To cut a new release, simply merge the PR from [`Release-plz`](https://release-plz.ieni.dev/). -Then, release-plz will generate the CHANGELOG.md from the commit history, create -a new Github release and push a tag. -This triggers `cargo-dist` to build the binaries and installers and upload them -to the release. +When we are ready to push a new release, do the following: +- Update `cargo.toml` with the new tag, and commit the change. +- To trigger a release, push a tag to the `main` branch with the version that + needs to be release. + This triggers `cargo-dist` to build the binaries and installers and upload them + to the release. + - For example: `git tag v0.0.0 && git push --tags` +- To publish on `crates.io`, use `cargo publish` after triggering `cargo-dist`. + +And you're done! You might want to edit the release made automatically by +`cargo-dist` with more information, perhaps by adding a changelog. ## Contributions Currently, the Kerblam! maintainer is [MrHedmad](https://github.com/MrHedmad).