Example workflows do not seem to be the latest workflows currently used in laminas and mezzio

[visto9259]

Bug Report

Q	A
Version(s)	N/A

Summary

The workflows in the example folder that one is supposed to copy to a repository, are not the same as what is currently used in repositories.

Current behavior

The example workflows have detailed steps for the release job, and are out of date.

Expected behavior

The workflows currently used in laminas/mezzio repos refer to the shared workflow. The examples should be updated.

release-on-milestone-closed.yml:

name: "Automatic Releases"

on:
  milestone:
    types:
      - "closed"

jobs:
  release:
    uses: laminas/workflow-automatic-releases/.github/workflows/[email protected]
    secrets:
      GIT_AUTHOR_EMAIL: ${{ secrets.GIT_AUTHOR_EMAIL }}
      GIT_AUTHOR_NAME: ${{ secrets.GIT_AUTHOR_NAME }}
      ORGANIZATION_ADMIN_TOKEN: ${{ secrets.ORGANIZATION_ADMIN_TOKEN }}
      SIGNING_SECRET_KEY: ${{ secrets.SIGNING_SECRET_KEY }}

Do we still need release-on-milestone-closed-triggering-release-event.yml?

If not, then the README.md file needs to be update to remove the reference to it.

[Ocramius]

I don't fully remember the difference between the two: only one is relevant.

The reusable pipeline is just one way to use this: personally, I have (and will) use the underlying steps manually: https://github.com/Ocramius/PackageVersions/blob/0d4fe53a4910686c59e98fdf27693ee9af49179d/.github/workflows/release-on-milestone-closed.yml#L3

On some private GitHub projects, for example, I run various intermediate steps before releasing.

Laminas is not the only audience of this project.

[Ocramius]

I'd rather divide in two examples:

1. The quick & easy way
2. The past examples, perhaps revamped a bit

I can't really diff the two files in the examples from mobile: cannot remember why I made two files.

[visto9259]

It looks like the pipeline came after the examples.
So the pipeline version is the quick way and the examples are the more detailed approach.
I started using it in LM-Commons and that where I noticed it was different than in Laminas' repos. The examples need to be updated as well, like the version of the checkout which is now at v4.

[visto9259]

The only difference between the two examples is in the use of secrets.ORGANIZATION_ADMIN_TOKEN vs secrets.GITHUB_TOKEN as the token used in the Release step.
The version in the 'workflow-automatic-releases' repo looks the same as the release-on-milestone-closed-triggering-release-event.yml example.

So I agree that the README should propose two approaches

1. Quick and easy, using the pipeline from 'workflow-automatic-releases'
2. The more detailed examples, updated, that users are free, as always, to modify to suit their needs