Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve release script #917

Open
wants to merge 17 commits into
base: main
Choose a base branch
from
Open

Improve release script #917

wants to merge 17 commits into from

Commits on Jul 1, 2024

  1. move tag_regex to variables section

    @plbstl
    plbstl committed Jul 1, 2024
    Configuration menu
    Copy the full SHA
    67934fe View commit details
    Browse the repository at this point in the history

  2. improve the git describe command 

    - When using the [action versioning recommendations](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md#recommendations), a commit can have duplicate tags (v2, v2.1.2).
- The previous implementation did not take that into consideration.
- With this new implementation, v2.1.2 is returned even when v2 is the newer commit tag (which is usually the case).
- Also, when running this script from another branch (let's say 'releases/v1'), the previous implementation would return newer tags in other branches.
- NOTE: This new implementation only searches for annotated tags.
    @plbstl
    plbstl committed Jul 1, 2024
    Configuration menu
    Copy the full SHA
    be270a6 View commit details
    Browse the repository at this point in the history

  3. terminate script when a command fails 

    - Previously, when the git push command failed, the script would still echo a success message.
- This commit also makes sure the git describe command does not terminate the script.
    @plbstl
    plbstl committed Jul 1, 2024
    Configuration menu
    Copy the full SHA
    35b1cc8 View commit details
    Browse the repository at this point in the history

  4. use --follow-tags flag to push to remote 

    - Using `--follow-tags` instead of `--tags` can be the saner option
- `follow-tags` also pushes commits
    @plbstl
    plbstl committed Jul 1, 2024
    Configuration menu
    Copy the full SHA
    4b33f5f View commit details
    Browse the repository at this point in the history

  5. make the colored text bold

    @plbstl
    plbstl committed Jul 1, 2024
    Configuration menu
    Copy the full SHA
    a28b58b View commit details
    Browse the repository at this point in the history

  6. remind user to update version field in package.json

    @plbstl
    plbstl committed Jul 1, 2024
    Configuration menu
    Copy the full SHA
    371c87b View commit details
    Browse the repository at this point in the history

  7. improve debug messages

    @plbstl
    plbstl committed Jul 1, 2024
    Configuration menu
    Copy the full SHA
    c3a8d43 View commit details
    Browse the repository at this point in the history

  8. spell out the git command flags used

    @plbstl
    plbstl committed Jul 1, 2024
    Configuration menu
    Copy the full SHA
    43c2d7b View commit details
    Browse the repository at this point in the history

  9. update the major version tag when creating a new release

    @plbstl
    plbstl committed Jul 1, 2024
    Configuration menu
    Copy the full SHA
    a6f9ca5 View commit details
    Browse the repository at this point in the history

  10. consider the new release being a major release 

    This implementation also creates a `releases/v#` branch off of the previous major version tag
    @plbstl
    plbstl committed Jul 1, 2024
    Configuration menu
    Copy the full SHA
    1c49bf9 View commit details
    Browse the repository at this point in the history

  11. minor comment change

    @plbstl
    plbstl committed Jul 1, 2024
    Configuration menu
    Copy the full SHA
    5613359 View commit details
    Browse the repository at this point in the history

  12. update script steps

    @plbstl
    plbstl committed Jul 1, 2024
    Configuration menu
    Copy the full SHA
    9da7ccc View commit details
    Browse the repository at this point in the history

  13. update readme to reflect changes made

    @plbstl
    plbstl committed Jul 1, 2024
    Configuration menu
    Copy the full SHA
    3b79f20 View commit details
    Browse the repository at this point in the history

  14. add link to action versioning recommendation

    @plbstl
    plbstl committed Jul 1, 2024
    Configuration menu
    Copy the full SHA
    d393e54 View commit details
    Browse the repository at this point in the history

  15. update Publishing a New Release docs

    @plbstl
    plbstl committed Jul 1, 2024
    Configuration menu
    Copy the full SHA
    6590bf4 View commit details
    Browse the repository at this point in the history

  16. improve var names and comments

    @plbstl
    plbstl committed Jul 1, 2024
    Configuration menu
    Copy the full SHA
    8ca79d7 View commit details
    Browse the repository at this point in the history

  17. update Pushing changes to remote docs

    @plbstl
    plbstl committed Jul 1, 2024
    Configuration menu
    Copy the full SHA
    eef8edb View commit details
    Browse the repository at this point in the history