Skip to content

Commit f078b32

Browse files
authored
Merge pull request #47 from voxpupuli/modulesync
Update to module template files
2 parents 3b1372f + c22e5c4 commit f078b32

File tree

10 files changed

+35
-12
lines changed

10 files changed

+35
-12
lines changed

.github/CODEOWNERS

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
1+
# Managed by modulesync - DO NOT EDIT
2+
# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
3+
14
# No matter which file got changed, request a review from the main developers
25
* @voxpupuli/tools-containerimages

.github/dependabot.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
---
2+
# Managed by modulesync - DO NOT EDIT
3+
# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
4+
25
version: 2
36
updates:
47
# raise PRs for gem updates

.github/labeler.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
---
2+
# Managed by modulesync - DO NOT EDIT
3+
# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
4+
25
skip-changelog:
36
- head-branch: ['^release-*']

.github/release.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
---
2+
# Managed by modulesync - DO NOT EDIT
3+
# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
4+
25
# https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
36

47
changelog:

.github/workflows/labeler.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
---
2+
# Managed by modulesync - DO NOT EDIT
3+
# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
4+
25
name: Labeler 🏷️
36

47
on:

.github/workflows/release.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
---
2+
# Managed by modulesync - DO NOT EDIT
3+
# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
4+
25
name: Release 🚀
36

47
on:

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# Managed by modulesync - DO NOT EDIT
2+
# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
3+
14
.bundle/
25
.vendor/
36
vendor/

Gemfile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# frozen_string_literal: true
22

3+
# Managed by modulesync - DO NOT EDIT
4+
# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
5+
36
source ENV['GEM_SOURCE'] || 'https://rubygems.org'
47

58
group :release do

RELEASE.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
1-
# How to make a release
1+
# Release
22

33
## On a fork
44

5-
Initiate a Release Pull Request (PR). Ensure that the release branch includes the version in its name, as this will be utilized as the `future_version` for the GitHub changelog generator.
6-
7-
See Rakefile
8-
9-
```ruby
10-
config.future_release = `git rev-parse --abbrev-ref HEAD`.strip.split('-', 2).last
11-
```
12-
13-
Do the following:
5+
Please follow these instructions carefully.
6+
Ensure that you name the branch precisely as `release-vX.Y.Z`
7+
since this nomenclature is crucial for obtaining the `future_version` in the changelog.
8+
Your attention to this specific branch naming convention is essential for accurate version tracking in the changelog.
149

1510
```shell
1611
export RELEASE_VERSION="X.Y.Z"
@@ -23,11 +18,12 @@ bundle config set --local with 'release'
2318
bundle install
2419

2520
CHANGELOG_GITHUB_TOKEN="token_MC_tokenface" bundle exec rake changelog
26-
2721
git commit -am "Release v${RELEASE_VERSION}"
2822
git push origin release-v$RELEASE_VERSION
2923
```
3024

25+
Then open a PR, discuss and merge.
26+
3127
## After the merge, as a maintainer on upstream
3228

3329
```shell

Rakefile

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# frozen_string_literal: true
22

3+
# Managed by modulesync - DO NOT EDIT
4+
# https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
5+
36
begin
47
require 'rubygems'
58
require 'github_changelog_generator/task'
@@ -8,7 +11,7 @@ rescue LoadError
811
else
912
GitHubChangelogGenerator::RakeTask.new :changelog do |config|
1013
config.header = "# Changelog\n\nAll notable changes to this project will be documented in this file."
11-
config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog github_actions modulesync]
14+
config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog modulesync github_actions]
1215
config.user = 'voxpupuli'
1316
config.project = 'container-voxbox'
1417
# get branch name from git and strip off any prefixes (e.g. 'release-')

0 commit comments

Comments
 (0)