BigSamu / OpenSearch_Changelog_Workflow

A reusable workflow for automating changelog and release notes generation processes for OpenSearch repos
Apache License 2.0
0 stars 4 forks source link

Instruction to install github bot not available for a PR already in Process #62

Open LDrago27 opened 3 months ago

LDrago27 commented 3 months ago

I had a PR already open in OpenSearch- Dashboards project. Once the ChangeLog workflow was added, I recieved errors corresponding to the change log requirements like adding a valid description with an appropriate action. However I didn't receive an error mentioning that I had not installed the github bot, but the workflow kept failing.

Expected behaviour: There should have been an error message asking me to install the github bot rather than simply failing. Adding my PR where I had this issue for reference.

https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6492

BigSamu commented 3 months ago

Hi @LDrago27,

Thanks for opening this issue. I already talked with @ashwin-pc, and some users are having similar problems.

Question: are you sure that when you opened your atteched PR, you did it WITHOUT the OpenSearch Changeset Bot (i.e. GitHub App) being initially installed?

Please check the following 2 PR I opened against OSD for testing purposes:

If you take a look at PR 6576 (case with bot initially installed), the first message you get is the one below - which is the same one you received at the beginning of openning your PR. My theory is that you indeed had the bot already installed before opening your PR:

image

For the case of PR 6577 (bot not initially installed), if you take a look at it, you will see this initial message:

image

After reviewing the workflow logs for each case, I realized that for PR 6576 (case with bot initially installed), a log mentioning that the GitHub App had been detected was not printed.

image

But in PR 6577 (case without bot initially installed), a specific message indicates that a bot (GitHub App) has been detected.

image

Could you confirm with us the first question I asked you? If that is the case, what we should do is to correct the logs for a case like PR 6577 (case with bot initially installed). However, I wonder if a post-info message in the PR conversation would also be helpful in letting the user know that he is already using the bot to create a changeset file. Happy to hear your opinion.

@ashwin-pc, any thoughts on this too?

Regards,

Samuel

ashwin-pc commented 3 months ago

Here is another PR that has the same issue. I think the code you have to detect if the bot is installed is not working as expected. Not sure what the diff is, but @AMoo-Miki faced it too

BigSamu commented 3 months ago

Mmmmmm, ok I will bring an update this week. I have an idea to make things clearer for initial usage when the bot is installed.