Skip to content

Commit fd22d30

Browse files
committed
[changelog] Align consumer docs and workflow invocation (#28)
1 parent 54dff26 commit fd22d30

2 files changed

Lines changed: 8 additions & 8 deletions

File tree

.github/workflows/changelog.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ jobs:
108108
- name: Verify changelog update
109109
env:
110110
BASE_REF: ${{ github.event.pull_request.base.ref }}
111-
run: vendor/bin/dev-tools changelog:check --file="${CHANGELOG_FILE}" --against="origin/${BASE_REF}"
111+
run: composer dev-tools changelog:check -- --file="${CHANGELOG_FILE}" --against="origin/${BASE_REF}"
112112

113113
prepare_release_pull_request:
114114
name: Prepare Release Pull Request
@@ -160,7 +160,7 @@ jobs:
160160
version="${INPUT_VERSION}"
161161
source="input"
162162
else
163-
version="$(vendor/bin/dev-tools changelog:next-version --file="${CHANGELOG_FILE}")"
163+
version="$(composer dev-tools changelog:next-version -- --file="${CHANGELOG_FILE}")"
164164
source="inferred"
165165
fi
166166
@@ -172,14 +172,14 @@ jobs:
172172
RELEASE_VERSION: ${{ steps.version.outputs.value }}
173173
run: |
174174
release_date="$(date -u +%F)"
175-
vendor/bin/dev-tools changelog:promote "${RELEASE_VERSION}" --file="${CHANGELOG_FILE}" --date="${release_date}"
175+
composer dev-tools changelog:promote -- "${RELEASE_VERSION}" --file="${CHANGELOG_FILE}" --date="${release_date}"
176176
177177
- name: Render release notes preview
178178
env:
179179
RELEASE_VERSION: ${{ steps.version.outputs.value }}
180180
run: |
181181
mkdir -p .dev-tools
182-
vendor/bin/dev-tools changelog:show "${RELEASE_VERSION}" --file="${CHANGELOG_FILE}" > .dev-tools/release-notes.md
182+
composer dev-tools changelog:show -- "${RELEASE_VERSION}" --file="${CHANGELOG_FILE}" > .dev-tools/release-notes.md
183183
184184
- name: Create release preparation pull request
185185
id: create_pr
@@ -269,7 +269,7 @@ jobs:
269269
RELEASE_VERSION: ${{ steps.version.outputs.value }}
270270
run: |
271271
mkdir -p .dev-tools
272-
vendor/bin/dev-tools changelog:show "${RELEASE_VERSION}" --file="${CHANGELOG_FILE}" > .dev-tools/release-notes.md
272+
composer dev-tools changelog:show -- "${RELEASE_VERSION}" --file="${CHANGELOG_FILE}" > .dev-tools/release-notes.md
273273
274274
- name: Publish GitHub release
275275
env:

docs/usage/github-actions.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,18 +91,18 @@ wrapper in ``resources/github-actions/changelog.yml``.
9191
* Uses ``fetch-depth: 0`` so the base branch reference can be compared
9292
safely.
9393
* Fetches the base branch changelog reference.
94-
* Runs ``vendor/bin/dev-tools changelog:check`` against the base ref.
94+
* Runs ``composer dev-tools changelog:check -- --against=<base-ref>`` against the base ref.
9595
* Fails when the current branch does not add a meaningful ``Unreleased`` change.
9696
* **Manual Release Preparation**:
9797
* Checks out the repository default branch with full history.
9898
* Resolves the next version from ``Unreleased`` unless a version input is provided.
9999
* Promotes ``Unreleased`` into the selected version with the current UTC release date.
100100
* Writes a release-notes preview file to ``.dev-tools/release-notes.md`` with
101-
``vendor/bin/dev-tools changelog:show``.
101+
``composer dev-tools changelog:show -- <version>``.
102102
* Opens or updates a release-preparation pull request instead of committing directly to ``main``.
103103
* **Merged Release Pull Requests**:
104104
* Detects merged branches that match the configured release branch prefix.
105-
* Renders the released changelog section with ``vendor/bin/dev-tools changelog:show``.
105+
* Renders the released changelog section with ``composer dev-tools changelog:show -- <version>``.
106106
* Creates or updates the Git tag and GitHub release with the rendered changelog section as the release body.
107107

108108
**Inputs:**

0 commit comments

Comments
 (0)