Skip to content

Commit

Permalink
Release v3.0.0
Browse files Browse the repository at this point in the history
Signed-off-by: Robert Waffen <[email protected]>
  • Loading branch information
rwaffen committed Sep 26, 2024
1 parent 0fc4dd4 commit fa0cb61
Show file tree
Hide file tree
Showing 7 changed files with 136 additions and 122 deletions.
27 changes: 24 additions & 3 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,40 @@
---

# https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes

changelog:
exclude:
labels:
- ignore-for-release
- duplicate
- invalid
- modulesync
- question
- skip-changelog
- wont-fix
- wontfix
- github_actions

categories:
- title: Breaking Changes 🛠
labels:
- breaking-change
- backwards-incompatible

- title: New Features 🎉
labels:
- enhancement

- title: Bug Fixes 🐛
labels:
- bug

- title: Documentation Updates 📚
labels:
- documentation
- docs

- title: Dependency Updates ⬆️
labels:
- dependencies

- title: Other Changes
labels:
- "*"
34 changes: 0 additions & 34 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,40 +15,6 @@ jobs:
with:
fetch-depth: 0

# - name: Set up Ruby
# uses: ruby/setup-ruby@v1
# with:
# bundler-cache: true

# - name: Prep Environment
# run: |
# bundle config set --local with 'release'
# bundle install
# mkdir -p build

# - name: Get previous Tag
# id: get-previous-tag
# run: |
# EXCLUDES=$(git describe --abbrev=0 --tags)
# PTAG=$(git describe --abbrev=0 --tags --exclude="${EXCLUDES}")
# echo "previous_tag=${PTAG}" >> "$GITHUB_OUTPUT"

# - name: Generate Changelog
# env:
# CHANGELOG_GITHUB_TOKEN: ${{ github.token }}
# run: |
# bundle exec github_changelog_generator \
# --user ${{ github.repository_owner }} \
# --project "hdm" \
# --since-tag ${{ steps.get-previous-tag.outputs.previous_tag }} \
# --future-release ${{ github.ref_name }} \
# --output build/changelog.md

# - name: Create Release
# env:
# GH_TOKEN: ${{ github.token }}
# run: gh release create ${{ github.ref_name }} --notes-file build/changelog.md --title "Release ${{ github.ref_name }}"

- name: Create Release
env:
GH_TOKEN: ${{ github.token }}
Expand Down
91 changes: 76 additions & 15 deletions CHANGELOG.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -539,7 +539,7 @@ DEPENDENCIES
web-console (>= 3.3.0)

RUBY VERSION
ruby 3.3.4p94
ruby 3.3.5p100

BUNDLED WITH
2.5.3
34 changes: 34 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Release

## On a fork

Please follow these instructions carefully.
Ensure that you name the branch precisely as `release-vX.Y.Z`
since this nomenclature is crucial for obtaining the `future_version` in the changelog.
Your attention to this specific branch naming convention is essential for accurate version tracking in the changelog.

```shell
export RELEASE_VERSION="X.Y.Z"
git switch main
git pull --rebase
git switch -c release-v$RELEASE_VERSION

bundle config set --local path vendor/bundle
bundle config set --local with 'release'
bundle install

CHANGELOG_GITHUB_TOKEN="token_MC_tokenface" bundle exec rake changelog
git commit ---signoff -all --message "Release v${RELEASE_VERSION}"
git push --set-upstream origin HEAD
```

Then open a PR, discuss and merge.

## After the merge, as a maintainer on upstream

```shell
git switch main
git pull --rebase
git tag v$RELEASE_VERSION -m "v$RELEASE_VERSION"
git push --tags
```
68 changes: 0 additions & 68 deletions RELEASE_howto.md

This file was deleted.

2 changes: 1 addition & 1 deletion Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ begin
require 'github_changelog_generator/task'
GitHubChangelogGenerator::RakeTask.new :changelog do |config|
config.header = "# Changelog\n\nAll notable changes to this project will be documented in this file.\nEach new release typically also includes the latest modulesync defaults.\nThese should not affect the functionality of the module."
config.exclude_labels = %w[duplicate question invalid wontfix wont-fix modulesync skip-changelog]
config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog github_actions]
config.user = 'betadots'
config.project = 'hdm'
# get branch name from git and strip off any prefixes (e.g. 'release-')
Expand Down

0 comments on commit fa0cb61

Please sign in to comment.