Compare commits

...

6 commits

Author SHA1 Message Date
stefanzweifel
b3a7ae7d4a Update CHANGELOG 2024-11-16 09:21:03 +00:00
Stefan Zweifel
a938690fad
Update CLI to v1.12 (#46) 2024-11-16 10:18:57 +01:00
stefanzweifel
66a0960fe2 Update CHANGELOG 2024-05-18 12:02:10 +00:00
Stefan Zweifel
61ce794778
Update CLI to v1.11 (#45)
* Update Dependencies

* Publish new Binary
2024-05-18 13:57:22 +02:00
Filippo
d039f3bb96
Fix typos in README.md (#44) 2024-01-17 21:26:16 +05:00
stefanzweifel
ce438d6b18 Update CHANGELOG 2023-11-25 14:40:42 +00:00
4 changed files with 110 additions and 83 deletions

View file

@ -5,9 +5,39 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased](https://github.com/stefanzweifel/changelog-updater-action/compare/v1.9.1...HEAD)
## [Unreleased](https://github.com/stefanzweifel/changelog-updater-action/compare/v1.12.0...HEAD)

<!-- New Release notes will be placed here automatically -->
## [v1.12.0](https://github.com/stefanzweifel/changelog-updater-action/compare/v1.11.0...v1.12.0) - 2024-11-16

### Changed

- Update CLI to v1.12 ([#46](https://github.com/stefanzweifel/changelog-updater-action/pull/46))

## [v1.11.0](https://github.com/stefanzweifel/changelog-updater-action/compare/v1.10.0...v1.11.0) - 2024-05-18

### Added

- Add compare URLs to release heading based on previous release heading when no unreleased heading is available ([stefanzweifel/php-changelog-updater#52](https://github.com/stefanzweifel/php-changelog-updater/pull/52))

### Changed

- Update CLI to v1.11 ([#45](https://github.com/stefanzweifel/changelog-updater-action/pull/45))

### Fixed

- Fix typos in README.md ([#44](https://github.com/stefanzweifel/changelog-updater-action/pull/44))

## [v1.10.0](https://github.com/stefanzweifel/changelog-updater-action/compare/v1.9.1...v1.10.0) - 2023-11-25

### Added

- Upgrade CLI to Support PHP 8.3 ([#42](https://github.com/stefanzweifel/changelog-updater-action/pull/42))

### Changed

- Update README with new versions of actions/checkout and git-auto-commit-action ([#41](https://github.com/stefanzweifel/changelog-updater-action/pull/41))

## [v1.9.1](https://github.com/stefanzweifel/changelog-updater-action/compare/v1.9.0...v1.9.1) - 2023-08-01

### Fixed

View file

@ -18,7 +18,7 @@ The Action is best used in a Workflow that listens to the `release`-event and th

The following is an example Workflow ready to be used.

The Workflow checks out [the target branch of the release](https://docs.github.com/en/rest/reference/releases#create-a-release--parameters), updates the `./CHANGELOG.md`-file with the name and the contents of the just released release and commits the changes back to your repository using [git-auto-commit](https://github.com/stefanzweifel/git-auto-commit-action).
The Workflow checks out [the target branch of the release](https://docs.github.com/en/rest/releases/releases#create-a-release--parameters), updates the `./CHANGELOG.md`-file with the name and the contents of the just released release and commits the changes back to your repository using [git-auto-commit](https://github.com/stefanzweifel/git-auto-commit-action).

```yaml
# .github/workflows/update-changelog.yaml
@ -62,8 +62,8 @@ To generate the release notes automatically for you, I can recommend using the [

> **Note**
> When you use the `publish`-input of _release-drafter_ to immediately create the release, the `release`-event is probably not triggered due to a limitation of GitHub Actions.
> Please create a personl access token, add it as a secret to your repository and pass the token to the `release-drafter/release-drafter`-Action.
> See [this discussion](https://github.com/stefanzweifel/changelog-updater-action/discussions/30) for mor details.
> Please create a personal access token, add it as a secret to your repository and pass the token to the `release-drafter/release-drafter`-Action.
> See [this discussion](https://github.com/stefanzweifel/changelog-updater-action/discussions/30) for more details.


### Advanced Usage
@ -98,7 +98,7 @@ jobs:

permissions:
# Give the default GITHUB_TOKEN write permission to commit and push the
# updaetd CHANGELOG back to the repository.
# updated CHANGELOG back to the repository.
# https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/
contents: write

@ -106,7 +106,7 @@ jobs:
- name: Checkout code
uses: actions/checkout@v4
with:
# Fetch entire history of repository to ensure relase date can be
# Fetch entire history of repository to ensure release date can be
# extracted from commit of the given tag.
fetch-depth: 0
# Checkout target branch of this release. Ensures that the CHANGELOG
@ -127,7 +127,7 @@ jobs:
latest-version: ${{ github.event.release.tag_name }}

# Optional
# If your project keeps seperate branches for major releases, and you want to point the compare URL
# If your project keeps separate branches for major releases, and you want to point the compare URL
# in the "Unreleased"-heading to the corresponding major release branch (eg. `2.x`), then enable the option
# below.
# `compare-url-target-revision` will change how the compare URL is composed and will replace
@ -155,7 +155,7 @@ The workflow …

- is manually triggered
- builds a Java project
- uses the content between the Unreleased and Previous Release heading as relase notes and updates the CHANGELOG.md
- uses the content between the Unreleased and Previous Release heading as release notes and updates the CHANGELOG.md
- commits the changes and pushes them to GitHub
- creates a new GitHub release and points in the release notes to the right heading for the just released version

@ -188,14 +188,14 @@ Your changelog will look something like this:
- Initial Release
```

If you want to learn more on how the Action determines the place for the release notes, read the the [notes in the README of the CLI](https://github.com/stefanzweifel/php-changelog-updater#expected-changelog-formats) that powers this Action.
If you want to learn more on how the Action determines the place for the release notes, read the [notes in the README of the CLI](https://github.com/stefanzweifel/php-changelog-updater#expected-changelog-formats) that powers this Action.

## Outputs

The Action exposes some outputs you can further use in your workflow. The Action currently supports the following outputs:

### `release_compare_url`
The generated compare URL for the just created relase. For example `https://github.com/org/repo/compare/v1.0.0...v1.1.0`.
The generated compare URL for the just created release. For example `https://github.com/org/repo/compare/v1.0.0...v1.1.0`.
The value is only available, if the Action could generate a compare URL based on the available CHANGELOG data.

### `release_url_fragment`

Binary file not shown.

143
composer.lock generated
View file

@ -8,16 +8,16 @@
"packages": [
{
"name": "dflydev/dot-access-data",
"version": "v3.0.2",
"version": "v3.0.3",
"source": {
"type": "git",
"url": "https://github.com/dflydev/dflydev-dot-access-data.git",
"reference": "f41715465d65213d644d3141a6a93081be5d3549"
"reference": "a23a2bf4f31d3518f3ecb38660c95715dfead60f"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/dflydev/dflydev-dot-access-data/zipball/f41715465d65213d644d3141a6a93081be5d3549",
"reference": "f41715465d65213d644d3141a6a93081be5d3549",
"url": "https://api.github.com/repos/dflydev/dflydev-dot-access-data/zipball/a23a2bf4f31d3518f3ecb38660c95715dfead60f",
"reference": "a23a2bf4f31d3518f3ecb38660c95715dfead60f",
"shasum": ""
},
"require": {
@ -77,22 +77,22 @@
],
"support": {
"issues": "https://github.com/dflydev/dflydev-dot-access-data/issues",
"source": "https://github.com/dflydev/dflydev-dot-access-data/tree/v3.0.2"
"source": "https://github.com/dflydev/dflydev-dot-access-data/tree/v3.0.3"
},
"time": "2022-10-27T11:44:00+00:00"
"time": "2024-07-08T12:26:09+00:00"
},
{
"name": "league/commonmark",
"version": "2.4.1",
"version": "2.5.3",
"source": {
"type": "git",
"url": "https://github.com/thephpleague/commonmark.git",
"reference": "3669d6d5f7a47a93c08ddff335e6d945481a1dd5"
"reference": "b650144166dfa7703e62a22e493b853b58d874b0"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/thephpleague/commonmark/zipball/3669d6d5f7a47a93c08ddff335e6d945481a1dd5",
"reference": "3669d6d5f7a47a93c08ddff335e6d945481a1dd5",
"url": "https://api.github.com/repos/thephpleague/commonmark/zipball/b650144166dfa7703e62a22e493b853b58d874b0",
"reference": "b650144166dfa7703e62a22e493b853b58d874b0",
"shasum": ""
},
"require": {
@ -105,8 +105,8 @@
},
"require-dev": {
"cebe/markdown": "^1.0",
"commonmark/cmark": "0.30.0",
"commonmark/commonmark.js": "0.30.0",
"commonmark/cmark": "0.31.1",
"commonmark/commonmark.js": "0.31.1",
"composer/package-versions-deprecated": "^1.8",
"embed/embed": "^4.4",
"erusev/parsedown": "^1.0",
@ -115,10 +115,10 @@
"michelf/php-markdown": "^1.4 || ^2.0",
"nyholm/psr7": "^1.5",
"phpstan/phpstan": "^1.8.2",
"phpunit/phpunit": "^9.5.21",
"phpunit/phpunit": "^9.5.21 || ^10.5.9 || ^11.0.0",
"scrutinizer/ocular": "^1.8.1",
"symfony/finder": "^5.3 | ^6.0",
"symfony/yaml": "^2.3 | ^3.0 | ^4.0 | ^5.0 | ^6.0",
"symfony/finder": "^5.3 | ^6.0 || ^7.0",
"symfony/yaml": "^2.3 | ^3.0 | ^4.0 | ^5.0 | ^6.0 || ^7.0",
"unleashedtech/php-coding-standard": "^3.1.1",
"vimeo/psalm": "^4.24.0 || ^5.0.0"
},
@ -128,7 +128,7 @@
"type": "library",
"extra": {
"branch-alias": {
"dev-main": "2.5-dev"
"dev-main": "2.6-dev"
}
},
"autoload": {
@ -185,7 +185,7 @@
"type": "tidelift"
}
],
"time": "2023-08-30T16:55:00+00:00"
"time": "2024-08-16T11:46:16+00:00"
},
{
"name": "league/config",
@ -271,31 +271,31 @@
},
{
"name": "nette/schema",
"version": "v1.2.5",
"version": "v1.3.2",
"source": {
"type": "git",
"url": "https://github.com/nette/schema.git",
"reference": "0462f0166e823aad657c9224d0f849ecac1ba10a"
"reference": "da801d52f0354f70a638673c4a0f04e16529431d"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/nette/schema/zipball/0462f0166e823aad657c9224d0f849ecac1ba10a",
"reference": "0462f0166e823aad657c9224d0f849ecac1ba10a",
"url": "https://api.github.com/repos/nette/schema/zipball/da801d52f0354f70a638673c4a0f04e16529431d",
"reference": "da801d52f0354f70a638673c4a0f04e16529431d",
"shasum": ""
},
"require": {
"nette/utils": "^2.5.7 || ^3.1.5 || ^4.0",
"php": "7.1 - 8.3"
"nette/utils": "^4.0",
"php": "8.1 - 8.4"
},
"require-dev": {
"nette/tester": "^2.3 || ^2.4",
"nette/tester": "^2.5.2",
"phpstan/phpstan-nette": "^1.0",
"tracy/tracy": "^2.7"
"tracy/tracy": "^2.8"
},
"type": "library",
"extra": {
"branch-alias": {
"dev-master": "1.2-dev"
"dev-master": "1.3-dev"
}
},
"autoload": {
@ -327,26 +327,26 @@
],
"support": {
"issues": "https://github.com/nette/schema/issues",
"source": "https://github.com/nette/schema/tree/v1.2.5"
"source": "https://github.com/nette/schema/tree/v1.3.2"
},
"time": "2023-10-05T20:37:59+00:00"
"time": "2024-10-06T23:10:23+00:00"
},
{
"name": "nette/utils",
"version": "v4.0.3",
"version": "v4.0.5",
"source": {
"type": "git",
"url": "https://github.com/nette/utils.git",
"reference": "a9d127dd6a203ce6d255b2e2db49759f7506e015"
"reference": "736c567e257dbe0fcf6ce81b4d6dbe05c6899f96"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/nette/utils/zipball/a9d127dd6a203ce6d255b2e2db49759f7506e015",
"reference": "a9d127dd6a203ce6d255b2e2db49759f7506e015",
"url": "https://api.github.com/repos/nette/utils/zipball/736c567e257dbe0fcf6ce81b4d6dbe05c6899f96",
"reference": "736c567e257dbe0fcf6ce81b4d6dbe05c6899f96",
"shasum": ""
},
"require": {
"php": ">=8.0 <8.4"
"php": "8.0 - 8.4"
},
"conflict": {
"nette/finder": "<3",
@ -413,9 +413,9 @@
],
"support": {
"issues": "https://github.com/nette/utils/issues",
"source": "https://github.com/nette/utils/tree/v4.0.3"
"source": "https://github.com/nette/utils/tree/v4.0.5"
},
"time": "2023-10-29T21:02:13+00:00"
"time": "2024-08-07T15:39:19+00:00"
},
{
"name": "psr/event-dispatcher",
@ -469,16 +469,16 @@
},
{
"name": "symfony/deprecation-contracts",
"version": "v3.4.0",
"version": "v3.5.0",
"source": {
"type": "git",
"url": "https://github.com/symfony/deprecation-contracts.git",
"reference": "7c3aff79d10325257a001fcf92d991f24fc967cf"
"reference": "0e0d29ce1f20deffb4ab1b016a7257c4f1e789a1"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/symfony/deprecation-contracts/zipball/7c3aff79d10325257a001fcf92d991f24fc967cf",
"reference": "7c3aff79d10325257a001fcf92d991f24fc967cf",
"url": "https://api.github.com/repos/symfony/deprecation-contracts/zipball/0e0d29ce1f20deffb4ab1b016a7257c4f1e789a1",
"reference": "0e0d29ce1f20deffb4ab1b016a7257c4f1e789a1",
"shasum": ""
},
"require": {
@ -487,7 +487,7 @@
"type": "library",
"extra": {
"branch-alias": {
"dev-main": "3.4-dev"
"dev-main": "3.5-dev"
},
"thanks": {
"name": "symfony/contracts",
@ -516,7 +516,7 @@
"description": "A generic function and convention to trigger deprecation notices",
"homepage": "https://symfony.com",
"support": {
"source": "https://github.com/symfony/deprecation-contracts/tree/v3.4.0"
"source": "https://github.com/symfony/deprecation-contracts/tree/v3.5.0"
},
"funding": [
{
@ -532,30 +532,27 @@
"type": "tidelift"
}
],
"time": "2023-05-23T14:45:45+00:00"
"time": "2024-04-18T09:32:20+00:00"
},
{
"name": "symfony/polyfill-php80",
"version": "v1.28.0",
"version": "v1.31.0",
"source": {
"type": "git",
"url": "https://github.com/symfony/polyfill-php80.git",
"reference": "6caa57379c4aec19c0a12a38b59b26487dcfe4b5"
"reference": "60328e362d4c2c802a54fcbf04f9d3fb892b4cf8"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/symfony/polyfill-php80/zipball/6caa57379c4aec19c0a12a38b59b26487dcfe4b5",
"reference": "6caa57379c4aec19c0a12a38b59b26487dcfe4b5",
"url": "https://api.github.com/repos/symfony/polyfill-php80/zipball/60328e362d4c2c802a54fcbf04f9d3fb892b4cf8",
"reference": "60328e362d4c2c802a54fcbf04f9d3fb892b4cf8",
"shasum": ""
},
"require": {
"php": ">=7.1"
"php": ">=7.2"
},
"type": "library",
"extra": {
"branch-alias": {
"dev-main": "1.28-dev"
},
"thanks": {
"name": "symfony/polyfill",
"url": "https://github.com/symfony/polyfill"
@ -599,7 +596,7 @@
"shim"
],
"support": {
"source": "https://github.com/symfony/polyfill-php80/tree/v1.28.0"
"source": "https://github.com/symfony/polyfill-php80/tree/v1.31.0"
},
"funding": [
{
@ -615,7 +612,7 @@
"type": "tidelift"
}
],
"time": "2023-01-26T09:26:14+00:00"
"time": "2024-09-09T11:45:10+00:00"
},
{
"name": "webmozart/assert",
@ -677,32 +674,32 @@
},
{
"name": "wnx/changelog-updater",
"version": "v1.10.0",
"version": "v1.12.0",
"source": {
"type": "git",
"url": "https://github.com/stefanzweifel/php-changelog-updater.git",
"reference": "46db8204729a0238ff9cf2a1cbd1263d9b3dd387"
"reference": "4b9095775f9ecdb1875b769faa8ac7917e300ba4"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/stefanzweifel/php-changelog-updater/zipball/46db8204729a0238ff9cf2a1cbd1263d9b3dd387",
"reference": "46db8204729a0238ff9cf2a1cbd1263d9b3dd387",
"url": "https://api.github.com/repos/stefanzweifel/php-changelog-updater/zipball/4b9095775f9ecdb1875b769faa8ac7917e300ba4",
"reference": "4b9095775f9ecdb1875b769faa8ac7917e300ba4",
"shasum": ""
},
"require": {
"ext-dom": "*",
"league/commonmark": "^2.3.5",
"php": "^8.1",
"php": "^8.2",
"webmozart/assert": "^1.11",
"wnx/commonmark-markdown-renderer": "^1.0.2"
},
"require-dev": {
"laravel-zero/framework": "^10",
"larastan/larastan": "^2.0",
"laravel-zero/framework": "^11",
"laravel/pint": "^1.10",
"mockery/mockery": "^1.5.1",
"pestphp/pest": "^2",
"rector/rector": "^0.18",
"vimeo/psalm": "^5.7"
"rector/rector": "^1.0"
},
"bin": [
"builds/changelog-updater"
@ -744,20 +741,20 @@
"type": "github"
}
],
"time": "2023-11-25T14:20:57+00:00"
"time": "2024-11-16T08:57:12+00:00"
},
{
"name": "wnx/commonmark-markdown-renderer",
"version": "v1.4.1",
"version": "v1.5.0",
"source": {
"type": "git",
"url": "https://github.com/stefanzweifel/commonmark-markdown-renderer.git",
"reference": "a500dd421c52057c6ba286afe07d48faa38686a6"
"reference": "08e2e9f13c7821d6f6e4c25d9a1cf45ef17ac212"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/stefanzweifel/commonmark-markdown-renderer/zipball/a500dd421c52057c6ba286afe07d48faa38686a6",
"reference": "a500dd421c52057c6ba286afe07d48faa38686a6",
"url": "https://api.github.com/repos/stefanzweifel/commonmark-markdown-renderer/zipball/08e2e9f13c7821d6f6e4c25d9a1cf45ef17ac212",
"reference": "08e2e9f13c7821d6f6e4c25d9a1cf45ef17ac212",
"shasum": ""
},
"require": {
@ -766,9 +763,9 @@
},
"require-dev": {
"friendsofphp/php-cs-fixer": "^3.0",
"phpstan/phpstan": "^1.10",
"phpunit/phpunit": "^10.0",
"rector/rector": "^0.15.17",
"vimeo/psalm": "^5.7"
"rector/rector": "^0.15.17"
},
"type": "library",
"autoload": {
@ -797,7 +794,7 @@
],
"support": {
"issues": "https://github.com/stefanzweifel/commonmark-markdown-renderer/issues",
"source": "https://github.com/stefanzweifel/commonmark-markdown-renderer/tree/v1.4.1"
"source": "https://github.com/stefanzweifel/commonmark-markdown-renderer/tree/v1.5.0"
},
"funding": [
{
@ -805,16 +802,16 @@
"type": "github"
}
],
"time": "2023-11-19T06:20:07+00:00"
"time": "2024-11-13T18:20:34+00:00"
}
],
"packages-dev": [],
"aliases": [],
"minimum-stability": "stable",
"stability-flags": [],
"stability-flags": {},
"prefer-stable": false,
"prefer-lowest": false,
"platform": [],
"platform-dev": [],
"plugin-api-version": "2.3.0"
"platform": {},
"platform-dev": {},
"plugin-api-version": "2.6.0"
}