Merge branch 'release/v1.3.0'

lumynou5 · lumynou5 · commit a41a7c4a7045 · 2024-12-24T17:34:57.000+08:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,162 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,11 +1,19 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [Unreleased]
+
+## [1.3.0] - 2024-12-24
+### Added
+- Output the changelog of last version.
+### Fixed
+- Add output `minor-tag` to action metadata.
+
 ## [1.2.0] - 2024-01-16
 ### Added
 - Minor tag.
 ### Changed
-- Major tag of major version 0.
+- Major tag of major version 0 is no longer created or moved.
 ### Fixed
 - Templates using multiple parameters work as expected now.
 
@@ -26,7 +34,7 @@ All notable changes to this project will be documented in this file.
 ### Added
 - First release.
 
-[1.2.2]: https://github.com/lumynou5/github-release-action/releases/tag/v1.2.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
 [1.0.1]: https://github.com/lumynou5/github-release-action/releases/tag/v1.0.1
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Lumynous
+Copyright (c) 2022-2024 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
diff --git a/README.md b/README.md
@@ -1,5 +1,6 @@
 # Lumynous GitHub Release Action
-This action creates GitHub releases automatically.
+
+Creates GitHub releases automatically.
 
 ## Usage
 
@@ -24,32 +25,52 @@ jobs:
 
 In this example workflow, it'll create a release whenever push to `main` branch.
 The version and the release note will be captured from the changelog following
-[Keep a Changelog](https://keepachangelog.com/) and [Semantic Versioning](https://semver.org/).
-And a Git tag will be created for the major revision, see [Inputs](#Inputs) for more information.
+[Keep a Changelog](https://keepachangelog.com/) and
+[Semantic Versioning](https://semver.org/).  And a Git tag will be created for
+the major revision, see [Inputs](#Inputs) for more information.
+
+This is useful to automatically publish releases on pushing to the stable branch
+when using Git flow, etc.
+
+Note that "moving tags" are considered an anti-pattern in Git and should only be
+used for GitHub actions.  This is due to GitHub actions' lack of semantic
+version functionality, which makes developers have to use tags like `v1` to let
+GitHub checkout latest version with major version `1` rather than matching a
+version pattern like `^1.0.0`.  To disable creating and editing moving tags, use
 
-This is useful to automatically publish releases on pushing to the stable branch when using Git flow, etc.
+```yml
+with:
+  major-tag-template: ''
+  minor-tag-template: ''
+```
 
 ## Inputs
+
 - `token` (required)
   The GitHub token.
 - `changelog`
   The path to the changelog. Default: `CHANGELOG.md`.
 - `tag-template`
   The template of the Git tag. Default: `v{version}`.
 - `major-tag-template`
-  The template of the Git tag of the major version. Doesn't perform if the major version is 0.
-  Default: `v{major}`. Empty for no major tag.
+  The template of the Git tag of the major version.  Doesn't perform if the
+  major version is 0.
+  Default: `v{major}`.  Empty for no major tag.
 - `minor-tag-template`
-  The template of the Git tag of the minor version. Default: `v{maojr}.{minor}`. Empty for no minor tag.
+  The template of the Git tag of the minor version.
+  Default: `v{maojr}.{minor}`.  Empty for no minor tag.
 - `name-template`
-  The template of the GitHub release. Default: `v{version}`.
+  The template of the GitHub release.
+  Default: `v{version}`.
 - `is-draft`
-  If the GitHub release is a draft. Default: `false`.
+  If the GitHub release is a draft.
+  Default: `false`.
+
+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
+will be replaced with data from your changelog; i.e. `{parameter-name}` will be
+replaced with the corresponding value.
 
-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 will be replaced with data from your changelog;
-i.e. `{parameter-name}` will be replaced with the corresponding value.
 - `version`
   The version.
 - `major`
@@ -66,7 +87,12 @@ i.e. `{parameter-name}` will be replaced with the corresponding value.
   The release date.
 
 ## Outputs
-The outputs include all the parameters of templates and the following items in addition.
+
+The outputs include all the parameters of templates and the following items in
+addition.
+
+- `change`
+  The changelog of the latest version.
 - `tag`
   The name of the Git tag.
 - `major-tag`
@@ -79,5 +105,6 @@ The outputs include all the parameters of templates and the following items in a
   The URL to upload assets for the GitHub release.
 
 ## License
+
 The source code is distributed under the MIT license.
 See [LICENSE.md](LICENSE.md) for further information.
diff --git a/action.yml b/action.yml
@@ -47,10 +47,14 @@ outputs:
     description: The build number or an empty string.
   release-date:
     description: The release date.
+  change:
+    description: The changelog of last version.
   tag:
     description: The name of the Git tag.
   major-tag:
     description: The name of the Git tag of the major version.
+  minor-tag:
+    description: The name of the Git tag of the minor version.
   html-url:
     description: The URL to the page of the GitHub release.
   upload-url:
diff --git a/main.py b/main.py
