blackjacx / backlog-notifier

Automatically create comments in tickets, including the release version, e.g. at when a PR gets released.

Hi there 👋

I'm Stefan and I just discovered this nice trick to show a a full markdown readme on top of my profile page. If you want to have the same checkout this.

This is Me

iOS Developer a.d. 2009 • iOS / OSX Enthusiast • WWDC19 • Passionate Mountainbiker

• 🔭 I’m the first mobile developer of ioki - the best company I've worked for so far. We develop, run and maintain a very powerful Demand-Responsive-Transport system in the name of Deutsche Bahn AG
• 🌱 I’m currently learning different things, like SwiftUI, all the niceties of the newest iOS and Xcode, always improve myself in Shell scripting since this was there before the dinosaurs 🦖 and will be there when aliens make friendships with humans 🔮.
• 👯 I’m looking to collaborate on different kinds of open source software
• 🤔 I’m looking for help with my own frameworks
• 💬 Ask me about just anything on Twitter

Connect with me

Languages and Tools

Github Stats

backlog-notifier's Issues

🔴 Error: Cannot read properties of undefined (reading 'body')

We often get this error and the notifier stops fails with that.
Unfourtnaly I can't share our changelog file. Maybe something is strange in there... 🤷
But would be grat to fix this 👍

Support multiple `backlog-ticket-prefix` in one PR

Currently the backlog-notifier supports only one mentioning of the backlog-ticket-prefix in the PR.
But it may happen that a PR fixes multiple backlog tickets.
It would be nice if the tool supports this so one PR will notify multiple backlog issues.

Notify all backlog items referenced in a PR

Git-ignore dependencies: `dist/index.js`

Tasks

• check compilation times:
  • with dependencies checked in
  • with dependencies generated on server
• Ideally refactor the whole systen to just generate dist/index.js on server 💡 (this is just noise in the PR)

Links

https://github.com/actions/setup-node

Write tests and a GH Action that runs them

See:

• https://github.com/actions/javascript-action/tree/main/__tests__ for how tests look like
• https://github.com/actions/javascript-action/tree/main#validate-the-action for how to write a workflow that validated an action in the same repo.

Use associative array for issue references in YML

Convert:

    - uses: blackjacx/[email protected]
      with:
        reference-repo-prefixes: 'BACKLOG, PIT, BUG, FEATURE, UX, QA, BEIWAGEN'
        reference-repo-names: 'backlog, pit-backlog, bugs, feature-requests, ux, qa, beiwagen'

to

    - uses: blackjacx/[email protected]
      with:
        - references:
             - repo-prefix: BACKLOG
                repo-name: backlog
             - repo-name: PIT
                repo-name: pit-backlog
               ....

It will be rendered like this:

{"references"=>[
  {"repo-prefix"=>"BACKLOG", "repo-name"=>backlog}, 
  {"repo-prefix"=>"PIT", "repo-name"=>pit-backlog}

This way ot is easier to preserve the prefix/name relationship. See https://stackoverflow.com/a/17173956/971329 for further infos.

Support an dynamic `CHANGELOG.md` path

Currently the path for the CHANGELOG.md is hardcoded.
So we have to add a file named CHANGELOG.md to the top tevel of the project.
For several reasons, we want to mvoe the location of the file.
it would be great if you could add it as an optional input to the action.

Exclude changelog entries not matching PR reference

• See this failing action: https://github.com/dbdrive/beiwagen-android/actions/runs/6263250089/job/17007213141
• Create a new test PR on GHTest repo for this case!

[Hackathon] Extend flexibility by adding `action` input

Extend the action so it can do more things than just post comments on other repo's tickets. Perspectively the GH action should evolve in a new tool called GitHub Issues Manager which is also able to manage GitHub project boards. The main reason behind this is the Backlog Notifier can just post comments at release time. The new parameter should enable the action to also move referenced issues from different repos (bugs, feature-requests, …) to a different lanes (e.g. done) on a specific project board at PR merge time. This shares core functionality from the existing backlog notifier: the identification of referenced issues but will run at a different time: after PR merge.

A second action could be to attach labels to those issues, e.g. QA Ready.

The benefit is that it closes a gap which GitHub cannot do right now and cleans up the developers project boards automatically by moving resolved tickets out of the way so they can focus on the unresolved ones. This also simplifies planning. Right now tickets from other repos on our project board have to be removed manually.

Expected Changes

• add new optional action parameter which can have the values (notify, move). When an unknown action is specified the action throws an error.
• add another optional parameter lane which can have an arbitrary string parameter and specifies the lane the issue should be moved to. When no lane is specified the action throws an error.
• Implement moving of an issue to a new lane
• Add new test PR to GHTest which we can open/close, like this one: Blackjacx/ghtest#23. (created Blackjacx/ghtest#24)
• Document the new parameters and refactor the existing documentation to a table which marks required and optional parameters

Write release.sh script

Performing all the steps in the readme by hand is tedious. Instead we can simply create a script that handles that.

DeprecationWarning: Buffer() is deprecated due to security and usability issues

When I run this action I get:

(node:1738) [DEP0005] DeprecationWarning: Buffer() is deprecated due to security and usability issues. Please use the Buffer.alloc(), Buffer.allocUnsafe(), or Buffer.from() methods instead.

I guess this should be fixed 🙃