Skip to content

Commit

Permalink
build: Updating workflow commitlint.yml.
Browse files Browse the repository at this point in the history
The .github/workflows/commitlint.yml workflow is missing or needs an update to stay in
sync with the current standard for this workflow as defined in the
`.github` repo of the `openedx` GitHub org.
  • Loading branch information
feanil committed Nov 27, 2023
1 parent 1edc7d3 commit 7030d6c
Showing 1 changed file with 1 addition and 34 deletions.
35 changes: 1 addition & 34 deletions .github/workflows/commitlint.yml
Original file line number Diff line number Diff line change
@@ -1,43 +1,10 @@
# Run commitlint on the commit messages in a pull request.
#
# This is the same worflow of
# https://github.com/openedx/.github/blob/master/.github/workflows/commitlint.yml
#
# We are using typescript with react-query on this MFE, and it is necessary
# to add one more step to remove tsconfig.json due to an issue in commitlint.
# https://github.com/conventional-changelog/commitlint/issues/3256
#
# We can return use the open edx workflow when the issue is fixed.

name: Lint Commit Messages

on:
- pull_request

defaults:
run:
shell: bash

jobs:
commitlint:
runs-on: ubuntu-20.04
steps:
- name: Check out the repo
uses: actions/checkout@v4
with:
# Fetch 100 commits. Should be enough?
fetch-depth: 100

- name: Download a local configuration file if needed
run: |
if [[ ! -f commitlint.config.js ]]; then
echo "Downloading the default commitlint config from edx_lint"
wget --no-verbose -O commitlint.config.js https://raw.githubusercontent.com/openedx/edx-lint/HEAD/edx_lint/files/commitlint.config.js
fi
- name: remove tsconfig.json # see issue https://github.com/conventional-changelog/commitlint/issues/3256
run: |
rm -f tsconfig.json
- name: Run commitlint
uses: wagoid/commitlint-github-action@v5
uses: openedx/.github/.github/workflows/commitlint.yml@master

0 comments on commit 7030d6c

Please sign in to comment.