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

Update standard workflow files. #2867

Merged
merged 1 commit into from
Nov 27, 2023
Merged

Update standard workflow files. #2867

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 1 addition & 22 deletions .github/workflows/commitlint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Run commitlint on the commit messages in a pull request.
# Currently overrides common openedx action as a workaround for fixing https://github.com/conventional-changelog/commitlint/issues/3256

name: Lint Commit Messages

Expand All @@ -8,24 +7,4 @@ on:

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

# This step is needed to fix https://github.com/conventional-changelog/commitlint/issues/3256
- name: Remove tsconfig file
run: rm tsconfig.json
Comment on lines -19 to -21
Copy link
Contributor

Choose a reason for hiding this comment

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

https://github.com/openedx/.github/blob/master/.github/workflows/commitlint.yml does not include this step.

The issue mentioned here (conventional-changelog/commitlint#3256) is still open, but I tested the repro steps (commitlint --from HEAD~2 --to HEAD) locally and found no errors.

The environment mentioned in the linked issue was:
commitlint --version 16.3.0
git --version 2.36.1
node --version 18.4.0

After running nvm use, my local environment was
commitlint --version 18.4.3
git --version 2.42.0
node --version 18.18.2

The commitlint gh action uses commitlint version ^18.2.0, and node version 20.9.0, so overall this feels safe to remove.


- 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: Run commitlint
uses: wagoid/commitlint-github-action@v5
uses: openedx/.github/.github/workflows/commitlint.yml@master
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is fixed in the latest version of the commit linter so the override is no longer needed.