Fix / update tagged-release workflow #426
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The 'version' file is created as part of the release process and is supposed to contain the version number of the tarball. The contents of this file become part of /sys/module/wacom/version, which we rely on to understand what driver version users are running. Recent release (1.0.0, 1.1.0, and 1.2.0) have had faulty version files which just contain the text "input-wacom". The issue was traced to the checkout action used by our tagged-release workflow. This action does not include tags by default, which prevents the git-version-gen script from being able to discover what version of the code is being built. In the absence of a git tag, it falls back to using the directory name instead: 'input-wacom'. Signed-off-by: Jason Gerecke <[email protected]>
jigpu
requested review from
Pinglinux,
skomra,
Joshua-Dickens and
flying-elephant
Pinglinux
reviewed
Jun 7, 2024
.github/workflows/tagged-release.yml
Outdated
|
|
||
| ## Commits | ||
| ${{ steps.get-shortlog.outputs.shortlog }} | ||
|
|
There was a problem hiding this comment.
extra whitespace/tab added here.
Pinglinux
reviewed
Jun 7, 2024
.github/workflows/tagged-release.yml
Outdated
| body: | | ||
| Commit description goes here. | ||
|
|
There was a problem hiding this comment.
extra whitespace/tab added here.
There was a problem hiding this comment.
Fixed. Didn't realize the YAML parser would allow me to remove this whitespace, but it looks like its valid after all.
|
The PR looks good. I tested it with "make dist" and my local repo. Both produced the correct version number. It can be merged once the two whitespaces are removed. |
Several warnings about deprecated functionality are logged when we run the tagged-release workflow. This commit updates the workflow to use the recommended replacements, cleans up some whitespace issues, and simplifies the release process. While we're at it, also tweak the auto-generated release notes to include a marked-up shortlog by default. Signed-off-by: Jason Gerecke <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a series of two commits. The first fixes the tagged-release workflow so that it generates a proper "version" file (needed for tarballs to attach the proper suffix to
/sys/module/wacom/version). The second does some miscellaneous cleanups and updates to the workflow.