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.

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

docs: pull request templates for new release process #351

Merged
merged 1 commit into from
Dec 4, 2023

Conversation

r4mmer
Copy link
Member

@r4mmer r4mmer commented Nov 3, 2023

Acceptance Criteria

  • Create the new pull request templates to follow the new release process

Description

We are using the features described in the github docs to create a PR template chooser and allow multiple PR templates on the github web ui.
These templates can also be used by name with the github cli or api (in a future integration) if needed.

Security Checklist

  • Make sure you do not include new dependencies in the project unless strictly necessary and do not include dev-dependencies as production ones. More dependencies increase the possibility of one of them being hijacked and affecting us.

@r4mmer r4mmer self-assigned this Nov 3, 2023
@r4mmer r4mmer changed the base branch from master to dev November 3, 2023 15:39
@@ -0,0 +1,8 @@

[//]: # (This should be discussed in the daily meeting)
Copy link
Member Author

Choose a reason for hiding this comment

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

This is just a simple hack to add some comments to the PR creator but without including them on the rendered PR.

For instance, this shows that the comment and surrounding blank lines will be ignored.

Captura de tela 2023-11-03 124334 Captura de tela 2023-11-03 124342

@r4mmer
Copy link
Member Author

r4mmer commented Nov 3, 2023

To better understand the new PR flow i'll add some screenshots of the expected behavior.

The default PR template will show as:

Captura de tela 2023-11-03 133625

The user will then click for preview and it will show this:

Captura de tela 2023-11-03 133636

We can then use the links to select the desired PR template.

@r4mmer r4mmer marked this pull request as ready for review November 27, 2023 19:25
@r4mmer r4mmer force-pushed the docs/pull_request_templates branch from bcc27ad to eebe9f9 Compare November 27, 2023 20:16
@r4mmer r4mmer requested a review from luislhl November 28, 2023 15:49
@@ -0,0 +1,8 @@

[//]: # (This should be discussed in the daily meeting)
[//]: # (Remember to bump the version to the release version after this is merged)
Copy link
Contributor

Choose a reason for hiding this comment

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

"after" or "before"? I guess this depends on the release guide being built, but I thought it would be before.

@r4mmer r4mmer requested review from alexruzenhack and removed request for pedroferreira1 November 29, 2023 14:20
@r4mmer r4mmer merged commit bab6be8 into dev Dec 4, 2023
5 of 7 checks passed
@r4mmer r4mmer deleted the docs/pull_request_templates branch December 4, 2023 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants