workday / canvas-kit-actions Goto Github PK

Step is here

utils/update-changelog.js is existing in CK, so that's why we don't have any failure, but this step should be more dynamic

## We could have gone the route of a lerna changeset plugin, but we would lose access to
    ## usernames which add a nice human touch to release notes
    - name: Update Changelog
      shell: bash
      run: node utils/update-changelog.js
      env:
        CHANGESET_TITLE: ${{steps.changeset.outputs.title}}
        CHANGESET_BODY: |
          ${{steps.changeset.outputs.body}}

canvas-tokens also needs to have PR check action that CK has, we need to check if we can remove it from CK and make it composite

• Add filter to get specific commits based on structure

Now generate changelog action generates changelog based on all commits made from specific tag. For multipackage repo we need to have opportunity to filter all commits and generate changelog based on selected commits only for specific package.

w/o filter

- feat(web): Add web tokens
- feat(mobile): Add mobile tokens
- chore: Add PR review GH action

with filter for web:

- feat(web): Add web tokens

• Have a way to set the default section title, now it's Components

🚀 Feature Proposal

Update documentation for GH actions:

• Create List of actions on the top of Readme
• Possibly have separated file for each action (?)
• Make action description clear:
  • have description and usage sections
  • have input/output tables with its description

Some pull requests have additional contributors and currently they are not given recognition. To fix this, a few things need to change.

• Update getMergeData to support multiple contributors from commits
  • Add commits to the GraphQL call
  • process commits to look for additional authors
  • Process additional authors, deduping by unique name and preferring login (Github username)
  • Add Co-authored-by: {name} <{email}> lines to the end of the commit message so GitHub attributes contributions
• Update getReleaseNotes to process the Co-authored-by strings to add additonal contributors in the release summary message

We ignore PR lint rules for dependabot PRs because they are autogenerated, but this causes empty releases because this causes empty merge messages.

For example, the release notes are empty: https://github.com/Workday/canvas-kit/releases/tag/v7.0.13

Here's the PR: Workday/canvas-kit#1492

The dependabot PRs lack the normally required "sections" (category and summary). The utility function that needs to be updated is the getSections found here:

The tests for getSections are unit tests found here:

The tests are set up the following way:

• input: The PR body. The contents of a Dependabot PR could be copy/pasted into the test
• expected: The sections that will be passed to create a merge title and body

For example, the linked PR should produce an expected sections like the following:

      const expected = {
        summary: 'Bumps [prismjs](https://github.com/PrismJS/prism) from 1.25.0 to 1.27.0.',
        'release category': 'Dependencies',
      }

No other code needs to be updated other than utils.ts and utils.test.ts which means the code should be 100% unit tested without worry our CI will crash!