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

ci: replace commitlint action with our own implementation #1845

Merged
5 commits merged into from
Feb 9, 2024
Merged

ci: replace commitlint action with our own implementation #1845

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
482069b
ci: replace github action with our own implementation
Feb 9, 2024
22adb12
style: remove blank line
Feb 9, 2024
245d436
test: empty commit 1
Feb 9, 2024
049409a
test: empty commit 2
Feb 9, 2024
76061e3
test: empty commit 3
Feb 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 24 additions & 5 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,10 +102,29 @@ jobs:
- name: Build design tokens 🛠️
run: yarn build:tokens

- name: Lint Commit Messages 👕
uses: wagoid/commitlint-github-action@v5
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Lint Javascript + SCSS 👕
run: yarn run lint --max-warnings=0

commitlint:
name: Lint Commit Messages 👕
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Setup node 😻
uses: actions/setup-node@v3
with:
node-version-file: '.node-version'
cache: 'yarn'
- name: Install Dependencies 🧶
run: yarn install --immutable
- name: Validate commits commitlint
# This workflow can also be triggered via "workflow_call".
# Since it's a push event we have access to these properties https://docs.github.com/en/webhooks/webhook-events-and-payloads#push
if: github.event_name == 'push'
run: |
COMMIT_COUNT=$(echo '${{ toJSON(github.event.commits) }}' | jq length)
Copy link
Contributor

Choose a reason for hiding this comment

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

How/where does jq get installed? Mostly out of curiousity...

Copy link
Author

Choose a reason for hiding this comment

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

Great question! Github runners (the github hosted virtual machines we run workflows on) come with a set of preinstalled software. This can be seen looking at the logs of the github action. Here's the link in the image below for reference https://github.com/actions/runner-images/blob/ubuntu22/20240204.1/images/ubuntu/Ubuntu2204-Readme.md

Screenshot 2024-02-09 at 3 12 15 PM

echo "Number of commits in the push: $COMMIT_COUNT"

yarn commitlint --from HEAD~$COMMIT_COUNT --to HEAD --verbose
Comment on lines +122 to +130
Copy link
Author

Choose a reason for hiding this comment

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

Credit to https://commitlint.js.org/#/guides-ci-setup?id=github-actions but I adjusted code to account for multiple commits being pushed up at once. Instead of using HEAD~1 we use HEAD~$COMMIT_COUNT

Loading