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.

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

Check change log in tag script #32

Merged
merged 2 commits into from
May 31, 2023

Conversation

newhoggy
Copy link
Collaborator

@newhoggy newhoggy commented May 31, 2023

Description

This script is used to tag components in a way that sanity checks various items before a tag is created and pushed.

To tag a new version of a component, the cabal file's version must first be modified committed and pushed.

The script checks if:

  • The commit has been pushed to the remote
  • The tag doesn't already exist
  • The tag hasn't already been pushed

This PR adds an additional check: The change log for the relevant component must have a section for the version being release.

Changelog

- description: |
    Check change log in tag script
  compatibility: no-api-changes
  type: maintenance

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • The change log section in the PR description has been filled in
  • New tests are added if needed and existing tests are updated. These may include:
    • golden tests
    • property tests
    • roundtrip tests
    • integration tests
      See Runnings tests for more details
  • Any changes are noted in the CHANGELOG.md for affected package
  • The version bounds in .cabal files are updated
  • CI passes. See note on CI. The following CI checks are required:
    • Code is linted with hlint. See .github/workflows/check-hlint.yml to get the hlint version
    • Code is formatted with stylish-haskell. See .github/workflows/stylish-haskell.yml to get the stylish-haskell version
    • Code builds on Linux, MacOS and Windows for ghc-8.10.7 and ghc-9.2.7
  • Self-reviewed the diff

Note on CI

If your PR is from a fork, the necessary CI jobs won't trigger automatically for security reasons.
You will need to get someone with write privileges. Please contact IOG node developers to do this
for you.

Copy link
Contributor

@carbolymer carbolymer May 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a brief description (to the file) what does this script do?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Description updated with more information.

@@ -20,6 +20,7 @@ cat dist-newstyle/cache/plan.json \
| { "component": ."component-name"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Useless use of cat in line 16.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I normally write code this way to structure it as a pipeline so that I can easily add a new proceses to the pipeline anywhere if necessary.

Copy link
Contributor

@Jimbo4350 Jimbo4350 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@newhoggy newhoggy added this pull request to the merge queue May 31, 2023
@newhoggy newhoggy removed this pull request from the merge queue due to a manual request May 31, 2023
@newhoggy newhoggy force-pushed the newhoggy/check-changelog-in-tag-script branch from 939c468 to 7c83bcf Compare May 31, 2023 13:37
@newhoggy newhoggy enabled auto-merge May 31, 2023 13:38
@newhoggy newhoggy added this pull request to the merge queue May 31, 2023
Merged via the queue into main with commit cb74de6 May 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants