Merge branch 'release/v2.0.0'

Author: lumynou5

.github/workflows/release.yml

@@ -9,9 +9,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v5
 
       - name: Release
-        uses: lumynou5/github-release-action@v1
+        uses: lumynou5/github-release-action@main
         with:
           token: ${{github.token}}

CHANGELOG.md

@@ -3,6 +3,13 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## [2.0.0] - 2025-10-30
+### Added
+- Uploading assets is supported now.
+### Changed
+- If the tag already exists, for example, the main branch is force pushed, now
+  the action won't fail and the release will be updated.
+
 ## [1.3.0] - 2024-12-24
 ### Added
 - Output the changelog of last version.
@@ -23,7 +30,8 @@ All notable changes to this project will be documented in this file.
 
 ## [1.1.0] - 2023-05-05 [YANKED]
 ### Added
-- Outputs the names of the Git tags of the release and the major version; i.e., the filled templates are outputed.
+- Outputs the names of the Git tags of the release and the major version; i.e.,
+  the filled templates are outputed.
 - Input `major-tag-template` can be empty for no major tag now.
 
 ## [1.0.1] - 2023-05-01
@@ -34,6 +42,9 @@ All notable changes to this project will be documented in this file.
 ### Added
 - First release.
 
+[Unreleased]: https://github.com/lumynou5/github-release-action/compare/v2.0.0...develop
+[2.0.0]: https://github.com/lumynou5/github-release-action/releases/tag/v2.0.0
+[1.3.0]: https://github.com/lumynou5/github-release-action/releases/tag/v1.3.0
 [1.2.0]: https://github.com/lumynou5/github-release-action/releases/tag/v1.2.0
 [1.1.1]: https://github.com/lumynou5/github-release-action/releases/tag/v1.1.1
 [1.1.0]: https://github.com/lumynou5/github-release-action/releases/tag/v1.1.0

LICENSE.md LICENSELICENSE.md renamed to LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022-2024 Lumynous
+Copyright (c) 2022-2025 Lumynous
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -18,9 +18,13 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Release
-        uses: lumynou5/github-release-action@v1
+        uses: lumynou5/github-release-action@v2
         with:
           token: ${{github.token}}
+          assets: |
+            dist/linux-x86_64
+            dist/windows.exe::windows version
+            dist/darwin:macos
 ```
 
 In this example workflow, it'll create a release whenever push to `main` branch.
@@ -65,6 +69,13 @@ with:
 - `is-draft`
   If the GitHub release is a draft.
   Default: `false`.
+- `assets`
+  A newline-separated list of files to upload.  Besides file paths, it also
+  accpets optional name and label (short description for the asset) separated by
+  colons.  For example, `path/to/file:name:label` renames the asset to `name`
+  instead of using the basename of the file.  The name can be omitted by leaving
+  an empty string there (so two colons in a row) if you want to set label only.
+  Default: empty.
 
 The following list shows the parameters that can be used in templates.  To use
 parameters, add a parameter name wrapping with braces to your template, and it

action.yml

@@ -32,6 +32,10 @@ inputs:
     description: If the GitHub release is a draft.
     required: false
     default: 'false'
+  assets:
+    description: A newline-separated list of files to upload.
+    required: false
+    default: ''
 outputs:
   version:
     description: The version.

bump_version.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/bash
+
+temp=$(mktemp)
+
+sed -e "
+/## \[Unreleased\]/{
+G;
+a\
+## [$1] - $(date -I)
+}
+/\[Unreleased\]:/a\
+[$1]: https://github.com/lumynou5/github-release-action/releases/tag/v$1
+s/v[[:digit:]]*\.[[:digit:]]*\.[[:digit:]]*\.\.\.develop/v$1...develop/
+" CHANGELOG.md >$temp
+
+cat $temp >CHANGELOG.md
+rm $temp

main.py

@@ -1,6 +1,7 @@
 from os import environ as env
 import keepachangelog
-from github import Github
+from github import Auth, Github, GithubException, UnknownObjectException
+from github.GithubObject import NotSet
 
 
 class Data(dict):
@@ -17,8 +18,10 @@ def getLatestChange():
     return list(changes.values())[0]
 
 
-github = Github(base_url=env['GITHUB_API_URL'],
-                login_or_token=env['INPUT_TOKEN'])
+github = Github(
+    base_url=env['GITHUB_API_URL'],
+    auth=Auth.Token(env['INPUT_TOKEN'])
+)
 repo = github.get_repo(env['GITHUB_REPOSITORY'])
 
 change = getLatestChange()
@@ -35,32 +38,56 @@ def getLatestChange():
 
 # Create release.
 data['tag'] = env['INPUT_TAG-TEMPLATE'].format_map(data)
-release = repo.create_git_release(
-    data['tag'],
-    env['INPUT_NAME-TEMPLATE'].format_map(data),
-    data['change'],
-    env['INPUT_IS-DRAFT'] == 'true',
-    data['prerelease'] is not None,
-    env['GITHUB_SHA'])
+try:
+    release = repo.create_git_release(
+        data['tag'],
+        env['INPUT_NAME-TEMPLATE'].format_map(data),
+        data['change'],
+        env['INPUT_IS-DRAFT'] == 'true',
+        data['prerelease'] is not None,
+        target_commitish=env['GITHUB_SHA']
+    )
+except GithubException as ex:
+    if ex.status != 422:
+        raise
+    # If the tag already exists.
+    release = repo.get_release(data['tag'])
+    release.update_release(
+        env['INPUT_NAME-TEMPLATE'].format_map(data),
+        data['change'],
+        target_commitish=env['GITHUB_SHA']
+    )
+    for asset in release.get_assets():
+        asset.delete_asset()
+
+# Upload assets.
+for entry in env['INPUT_ASSETS'].splitlines():
+    path, _, rest = entry.partition(':')
+    name, _, label = rest.partition(':')
+    release.upload_asset(
+        path,
+        name=name if name != '' else NotSet,
+        label=label
+    )
 
 # Move major tag.
 if env['INPUT_MAJOR-TAG-TEMPLATE'] != '' and data['major'] != 0:
     data['major_tag'] = env['INPUT_MAJOR-TAG-TEMPLATE'].format_map(data)
-    major = repo.get_git_ref(f'tags/{data["major_tag"]}')
-    if major.ref is not None:
+    try:
+        major = repo.get_git_ref(f'tags/{data["major_tag"]}')
         major.edit(env['GITHUB_SHA'])
-    else:
+    except UnknownObjectException:
         repo.create_git_ref(f'refs/tags/{data["major_tag"]}', env['GITHUB_SHA'])
 else:
     data['major_tag'] = ''
 
 # Move minor tag.
 if env['INPUT_MINOR-TAG-TEMPLATE'] != '':
     data['minor_tag'] = env['INPUT_MINOR-TAG-TEMPLATE'].format_map(data)
-    minor = repo.get_git_ref(f'tags/{data["minor_tag"]}')
-    if minor.ref is not None:
+    try:
+        minor = repo.get_git_ref(f'tags/{data["minor_tag"]}')
         minor.edit(env['GITHUB_SHA'])
-    else:
+    except UnknownObjectException:
         repo.create_git_ref(f'refs/tags/{data["minor_tag"]}', env['GITHUB_SHA'])
 else:
     data['minor_tag'] = ''

requirements.txt

@@ -1,2 +1,2 @@
-keepachangelog==2.0.0.dev5
-PyGithub==1.58.0
+keepachangelog==2.0.0
+PyGithub==2.8.1