Skip to content

Improve action that manages issue headers - #28

Merged
rtibbles merged 4 commits into
learningequality:mainfrom
MisRob:issue-header-action
Jul 22, 2025
Merged

Improve action that manages issue headers#28
rtibbles merged 4 commits into
learningequality:mainfrom
MisRob:issue-header-action

Conversation

@MisRob

@MisRobMisRob commented Jun 20, 2025

Copy link
Copy Markdown
Member

Summary

Improve action that manages issue headers:

  • Move shared part to a separate file
  • Trigger on open new issue event
  • Remove header from templates
  • Upgrade dependencies
  • Cache dependencies

I've developed and previewed in my replica of LE's GitHub, and also tested in test-actions40caf0f.

References

Follow-ups for @rtibbles recent feedback.

Reviewer guidance

Please don't merge. After approval, I will open companion PRs in the five repositories, and then we can merge everything together.

@MisRob
MisRobforce-pushed the issue-header-action branch 10 times, most recently from 0c7e9fa to d27caa4CompareJune 21, 2025 06:52
- Move shared part to a separate file
- Trigger on open new issue event
- Remove header from templates
@MisRob
MisRobforce-pushed the issue-header-action branch from d27caa4 to 9472b9aCompareJune 21, 2025 07:01
Comment thread.github/workflows/call-manage-issue-header.yml Outdated
Comment thread.github/workflows/manage-issue-header.yml Outdated
Comment thread.github/workflows/manage-issue-header.yml Outdated
@MisRob
MisRob requested a review from rtibblesJune 23, 2025 08:27
@MisRob
MisRob marked this pull request as ready for review June 23, 2025 08:27

@rtibblesrtibbles left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Code changes make sense - a couple of comments related to events.


on:
issues:
types: [opened, labeled, unlabeled]

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Just to cover some edge cases we can add reopened and transferred to this list.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Ah yes, thank you. I only added reopened here. I played around with transferred and the way it works is that a receiving repository will run opened event on issues that are transferred into it, so it's covered. However I updated the script to handle better both reopened and transferred issues. Tested successfully.

Comment thread.github/workflows/call-manage-issue-header.yml Outdated
manage-issue-header:
runs-on: ubuntu-latest
if: |
github.event.action == 'opened' ||

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Would need to add the other event names here too, presumably.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Yes, thanks!

@MisRob
MisRobforce-pushed the issue-header-action branch from 2ce9708 to 3251d3dCompareJuly 14, 2025 06:59
@MisRob

Copy link
Copy Markdown
MemberAuthor

@rtibbles I also pushed upgrade of dependencies and caching of node dependencies here. Tested the latest version on test-actions, all seemed to be good.

@MisRob
MisRob requested a review from rtibblesJuly 14, 2025 07:38
- name: Install dependencies
run: npm install
run: yarn install --frozen-lockfile

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This is yarn's version of npm ci - I've recently learned it's recommended approach in workflows. This is also a a reason why I am committing yarn.lock. When I have a while, I will upgrade and improve other community related workflows similarly.

@rtibbles
rtibbles merged commit 599fa57 into learningequality:mainJul 22, 2025
Sign up for freeto 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.

2 participants

@MisRob@rtibbles